Enum tokio::prelude::AsyncSink

pub enum AsyncSink<T> {
    Ready,
    NotReady(T),
}

The result of an asynchronous attempt to send a value to a sink.

Variants

Ready

The start_send attempt succeeded, so the sending process has started; you must use Sink::poll_complete to drive the send to completion.

NotReady(T)

The start_send attempt failed due to the sink being full. The value being sent is returned, and the current Task will be automatically notified again once the sink has room.

Implementations

impl<T> AsyncSink<T>

pub fn map<F, U>(self, f: F) -> AsyncSink<U>where
    F: FnOnce(T) -> U,

Change the NotReady value of this AsyncSink with the closure provided

pub fn is_ready(&self) -> bool

Returns whether this is AsyncSink::Ready

pub fn is_not_ready(&self) -> bool

Returns whether this is AsyncSink::NotReady

Trait Implementations

impl<T> Clone for AsyncSink<T>where
    T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> PartialEq<AsyncSink<T>> for AsyncSink<T>where
    T: PartialEq<T>,

fn eq(&self, other: &AsyncSink<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for AsyncSink<T>where
    T: Copy,

impl<T> StructuralPartialEq for AsyncSink<T>