Struct futures::channel::mpsc::Sender

source ·
pub struct Sender<T>(_);
Expand description

The transmission end of a bounded mpsc channel.

This value is created by the channel function.

Implementations§

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:

  • Poll::Ready(Ok(_)) if there is sufficient capacity;
  • Poll::Pending if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;
  • Poll::Ready(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.

Disconnects this sender from the channel, closing it if there are no more senders left.

Returns whether the senders send to the same receiver.

Returns whether the sender send to this receiver.

Hashes the receiver into the provided hasher

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
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 preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more
Flush any remaining output from this sink. Read more
Flush any remaining output and close this sink, if necessary. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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 sink, 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 item has been received by the sink. 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
A convenience method for calling Sink::poll_ready on Unpin sink types.
A convenience method for calling Sink::start_send on Unpin sink types.
A convenience method for calling Sink::poll_flush on Unpin sink types.
A convenience method for calling Sink::poll_close on Unpin sink types.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.