Struct futures::channel::mpsc::UnboundedSender

pub struct UnboundedSender<T>(_);

The transmission end of an unbounded mpsc channel.

This value is created by the unbounded function.

Methods

impl<T> UnboundedSender<T>

pub fn poll_ready(&self, &mut Context) -> Poll<Result<(), SendError>>

Check if the channel is ready to receive a message.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&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.

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

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

pub fn same_receiver(&self, other: &UnboundedSender<T>) -> bool

Returns whether the senders send to the same receiver.

Trait Implementations

impl<T> Debug for UnboundedSender<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<'_, T> Sink<T> for &'_ UnboundedSender<T>

type Error = SendError

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

fn poll_ready(
    self: Pin<&mut &'_ UnboundedSender<T>>,
    cx: &mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut &'_ UnboundedSender<T>>,
    msg: T
) -> Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>

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

fn poll_flush(
    self: Pin<&mut &'_ UnboundedSender<T>>,
    &mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut &'_ UnboundedSender<T>>,
    &mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>

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

impl<T> Sink<T> for UnboundedSender<T>

type Error = SendError

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

fn poll_ready(
    self: Pin<&mut UnboundedSender<T>>,
    cx: &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut UnboundedSender<T>>,
    msg: T
) -> Result<(), <UnboundedSender<T> as Sink<T>>::Error>

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

fn poll_flush(
    self: Pin<&mut UnboundedSender<T>>,
    &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut UnboundedSender<T>>,
    &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>

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

impl<T> Clone for UnboundedSender<T>

fn clone(&self) -> UnboundedSender<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.