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.

Implementations

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: &Self) -> bool

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 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.

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

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

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 Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::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 Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::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 Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::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 Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

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