Struct tokio_sync::mpsc::Sender

[+] Show declaration

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

[−] Expand description

Send values to the associated Receiver.

Instances are created by the channel function.

Implementations

impl<T> Sender<T>[−]

pub fn poll_ready(&mut self) -> Poll<(), SendError>[−]

Check if the Sender is ready to handle a value.

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

When poll_ready returns Ready, the channel reserves capacity for one message for this Sender instance. The capacity is held until a message is send or the Sender instance is dropped. Callers should ensure a message is sent in a timely fashion in order to not starve other Sender instances.

Return value

This method returns:

• Ok(Async::Ready(_)) if capacity is reserved for a single message.
• Ok(Async::NotReady) 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.

pub fn try_send(&mut self, message: T) -> Result<(), TrySendError<T>>[−]

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

Trait Implementations

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

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T> Debug for Sender<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError

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

fn start_send(&mut self, msg: T) -> StartSend<T, Self::SinkError>[−]

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), Self::SinkError>[−]

Flush all output from this sink, if necessary.

fn close(&mut self) -> Poll<(), Self::SinkError>[−]

A method to indicate that no more values will ever be pushed into this sink.

pub fn wait(self) -> Wait<Self>[−]

Creates a new object which will produce a synchronous sink.

pub fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>, [−]

Composes a function in front of the sink.

pub fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, [−]

Composes a function in front of the sink.

pub fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, [−]

Transforms the error returned by the sink.

pub fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
    E: From<Self::SinkError>, [−]

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink.

pub fn buffer(self, amt: usize) -> Buffer<Self>[−]

Adds a fixed-size buffer to the current sink.

pub fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, [−]

Fanout items to multiple sinks.

pub fn flush(self) -> Flush<Self>[−]

A future that completes when the sink has finished processing all pending requests.

pub fn send(self, item: Self::SinkItem) -> Send<Self>[−]

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

pub fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>, [−]

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