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

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

The transmission end of a channel which is used to send values.

This is created by the channel method.

Methods

impl<T> Sender<T>[src]

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

Attempts to send a message on this Sender<T> without blocking.

This function, unlike start_send, is safe to call whether it's being called on a task or not. Note that this function, however, will not attempt to block the current task if the message cannot be sent.

It is not recommended to call this function from inside of a future, only from an external thread where you've otherwise arranged to be notified when the channel is no longer full.

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

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

Returns Ok(Async::Ready(_)) if there is sufficient capacity, or returns Ok(Async::NotReady) if the channel is not guaranteed to have capacity. Returns Err(SendError(_)) if the receiver has been dropped.

Panics

This method will panic if called from outside the context of a task or future.

pub fn is_closed(&self) -> bool[src]

Returns whether this channel is closed without needing a context.

Trait Implementations

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

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError<T>

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

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

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

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

Auto Trait Implementations

impl<T> Unpin for Sender<T>

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

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> 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> Into<U> for T where
    U: From<T>, 
[src]

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> Borrow<T> for T where
    T: ?Sized
[src]

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

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

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

type Owned = T

The resulting type after obtaining ownership.