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

pub struct Sender<T>(_);

The transmission end of a bounded mpsc channel.

This value is created by the channel function.


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, returning the message if there was an error.

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

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.

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

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.

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

Returns whether this channel is closed without needing a context.

pub fn close_channel(&mut self)[src]

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

pub fn disconnect(&mut self)[src]

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

pub fn same_receiver(&self, other: &Sender<T>) -> bool[src]

Returns whether the senders send to the same receiver.

pub fn hash_receiver<H>(&self, hasher: &mut H) where
    H: Hasher

Hashes the receiver into the provided hasher

Trait Implementations

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

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

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

type Error = SendError

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for Sender<T>

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

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

impl<T> Unpin for Sender<T>

impl<T> !UnwindSafe for Sender<T>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

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

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

The type returned in the event of a conversion error.