Struct futures::channel::mpsc::Sender

[+] Show declaration

pub struct Sender<T>(_);

[−] Expand description

The transmission end of a bounded mpsc channel.

This value is created by the channel function.

Methods

impl<T> Sender<T>[−]

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

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

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

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

Returns whether this channel is closed without needing a context.

pub fn close_channel(&mut self)[+]

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

pub fn disconnect(&mut self)[+]

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

Trait Implementations

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

[+] Show hidden undocumented items

type SinkError = SendError

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

fn poll_ready(
    self: Pin<&mut Sender<T>>,
    cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[+]

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Sender<T>>,
    msg: T
) -> Result<(), <Sender<T> as Sink<T>>::SinkError>[+]

Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Sender<T>>,
    &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[+]

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Sender<T>>,
    &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[+]

Flush any remaining output and close this sink, if necessary.

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

[+] Show hidden undocumented items

fn clone(&self) -> Sender<T>[+]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T> where
    T: Debug, [+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[+]

Formats the value using the given formatter.