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

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

Check if the channel is ready to receive a message.

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

Returns whether this channel is closed without needing a context.

pub fn close_channel(&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 start_send(&mut self, msg: T) -> Result<(), SendError>[src]

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

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

Returns whether the senders send to the same receiver.

Trait Implementations

impl<'_, T> Sink<T> for &'_ UnboundedSender<T>[src]

type Error = SendError

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

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

type Error = SendError

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

impl<T> Debug for UnboundedSender<T> where
    T: Debug
[src]

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

Auto Trait Implementations

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

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

impl<T> Unpin for UnboundedSender<T>

impl<T> !UnwindSafe for UnboundedSender<T>

impl<T> !RefUnwindSafe for UnboundedSender<T>

Blanket Implementations

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = !

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

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