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) -> Result<Async<()>, 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 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.

Trait Implementations

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

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

Formats the value using the given formatter.

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> Sink for UnboundedSender<T>

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError

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

fn poll_ready(
    &mut self,
    cx: &mut Context
) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send(
    &mut self,
    msg: T
) -> Result<(), <UnboundedSender<T> as Sink>::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 Ok(Async::Ready(())).

fn poll_flush(
    &mut self,
    &mut Context
) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

Flush any remaining output from this sink.

fn poll_close(
    &mut self,
    &mut Context
) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

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

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

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError

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

fn poll_ready(
    &mut self,
    cx: &mut Context
) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send(
    &mut self,
    msg: T
) -> Result<(), <&'a UnboundedSender<T> as Sink>::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 Ok(Async::Ready(())).

fn poll_flush(
    &mut self,
    &mut Context
) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

Flush any remaining output from this sink.

fn poll_close(
    &mut self,
    &mut Context
) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

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