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

Trait Implementations

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

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

default fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

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

type SinkError = SendError

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

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

type SinkError = SendError

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

Auto Trait Implementations

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

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

Blanket Implementations

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

type Owned = T

impl<T> From for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

impl<T, U> TryInto 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> Any for T where
    T: 'static + ?Sized
[src]

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

default fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
    E: From<Self::SinkError>,
    F: FnMut(U) -> Fut,
    Fut: Future<Output = Result<Item, E>>, 
[src]

Composes a function in front of the sink. Read more

default fn with_flat_map<U, St, F>(
    self,
    f: F
) -> WithFlatMap<Self, Item, U, St, F> where
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Item, Self::SinkError>>, 
[src]

Composes a function in front of the sink. Read more

default fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, 
[src]

Transforms the error returned by the sink.

default fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
    Self::SinkError: Into<E>, 
[src]

Map this sink's error to a different error type using the Into trait. Read more

default fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src]

Adds a fixed-size buffer to the current sink. Read more

Important traits for Close<'_, Si, Item>
default fn close(&mut self) -> Close<Self, Item> where
    Self: Unpin
[src]

Close the sink.

default fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
    Item: Clone,
    Si: Sink<Item, SinkError = Self::SinkError>, 
[src]

Fanout items to multiple sinks. Read more

Important traits for Flush<'_, Si, Item>
default fn flush(&mut self) -> Flush<Self, Item> where
    Self: Unpin
[src]

Flush the sync, processing all pending items. Read more

Important traits for Send<'_, Si, Item>
default fn send(&mut self, item: Item) -> Send<Self, Item> where
    Self: Unpin
[src]

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

Important traits for SendAll<'_, Si, St>
default fn send_all<St>(
    &'a mut self,
    stream: &'a mut St
) -> SendAll<'a, Self, St> where
    Self: Unpin,
    St: Stream<Item = Item> + Unpin
[src]

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

default fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<Item, SinkError = Self::SinkError>, 
[src]

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

default fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<Item, SinkError = Self::SinkError>, 
[src]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

default fn compat(self) -> CompatSink<Self, Item> where
    Self: Unpin
[src]

Wraps a [Sink] into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more