[][src]Struct tokio_sync::mpsc::Sender

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

Send values to the associated Receiver.

Instances are created by the channel function.

Methods

impl<T> Sender<T>[src]

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

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>>[src]

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

Trait Implementations

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

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

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

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.

Auto Trait Implementations

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

impl<T> Unpin for Sender<T>

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

impl<T> !UnwindSafe for Sender<T>

impl<T> !RefUnwindSafe for Sender<T>

Blanket Implementations

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

type Owned = T

The resulting type after obtaining ownership.

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

impl<T> From<T> for T[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

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

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