[][src]Struct futures::channel::mpsc::Sender

pub struct Sender<T> { /* fields omitted */ }

The transmission end of a bounded mpsc channel.

This value is created by the channel function.

Methods

impl<T> Sender<T>
[src]

Attempts to send a message on this Sender, returning the message if there was an error.

Send a message on the channel.

This function should only be called after poll_ready has reported that the channel is ready to receive a message.

Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.

Return value

This method returns:

  • Ok(Async::Ready(_)) if there is sufficient capacity;
  • Ok(Async::Pending) if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;
  • Err(SendError) if the receiver has been dropped.

Returns whether this channel is closed without needing a context.

Closes this channel from the sender side, preventing any new messages.

Trait Implementations

impl<T> Sink for Sender<T>
[src]

The type of value that the sink accepts.

The type of value produced by the sink when an error occurs.

Attempts to prepare the Sink to receive a value. Read more

Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Poll::Ready(())). Read more

Flush any remaining output from this sink. Read more

Flush any remaining output and close this sink, if necessary. Read more

impl<T> Clone for Sender<T>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<T> Unpin for Sender<T>
[src]

impl<T> Drop for Sender<T>
[src]

Executes the destructor for this type. Read more

impl<T> Debug for Sender<T> where
    T: Debug
[src]

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> Send for Sender<T> where
    T: Send

impl<T> Sync for Sender<T> where
    T: Send

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> SinkExt for T where
    T: Sink + ?Sized
[src]

Composes a function in front of the sink. Read more

Composes a function in front of the sink. Read more

Transforms the error returned by the sink.

Map this sink's error to a different error type using the Into trait. Read more

Adds a fixed-size buffer to the current sink. Read more

Close the sink.

Fanout items to multiple sinks. Read more

Flush the sync, processing all pending items. Read more

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

Important traits for Compat<R>

Wraps a [Sink] into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more