Enum scoped_stream_sink::State

pub enum State<T, E> {
    Pending,
    Error(E),
    RecvReady,
    SendReady(T),
    SendRecvReady(T),
    End,
}

State enum for StreamSink.

Due to it’s complexity, the state of StreamSink is represented by this enum. Should be equivalent to Poll<Result<(Option<T>, bool), E>>.

Implements many useful From traits to ease conversion.

Variants

Pending

Is pending.

Error(E)

Is erroring.

RecvReady

Ready to receive item.

SendReady(T)

Has item to send.

SendRecvReady(T)

Combines RecvReady and SendReady.

End

Has no more data to send and cannot receive data anymore.

Implementations

impl<T, E> State<T, E>

pub fn is_pending(&self) -> bool

Returns true if state is pending.

pub fn is_recv(&self) -> bool

Returns true if state is ready to receive item.

pub fn is_send(&self) -> bool

Returns true if state has an item to send.

pub fn is_end(&self) -> bool

Returns true if state is ended

pub fn unwrap_content(self) -> Result<Option<T>, E>

Unwraps it’s content (if any).

Trait Implementations

impl<T: Clone, E: Clone> Clone for State<T, E>

fn clone(&self) -> State<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for State<T, E>

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

Formats the value using the given formatter.

impl<T: Display, E: Display> Display for State<T, E>

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

Formats the value using the given formatter.

impl<T, E> From<Poll<Result<(Option<T>, bool), E>>> for State<T, E>

fn from(value: Poll<Result<(Option<T>, bool), E>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Poll<Result<Option<T>, E>>> for State<T, E>

fn from(value: Poll<Result<Option<T>, E>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Poll<Result<T, E>>> for State<T, E>

fn from(value: Poll<Result<T, E>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<(Option<T>, bool), E>> for State<T, E>

fn from(value: Result<(Option<T>, bool), E>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<(Poll<Option<T>>, Poll<()>), E>> for State<T, E>

fn from(value: Result<(Poll<Option<T>>, Poll<()>), E>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<Option<T>, E>> for State<T, E>

fn from(value: Result<Option<T>, E>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<T, E>> for State<T, E>

fn from(value: Result<T, E>) -> Self

Converts to this type from the input type.

impl<T, E> From<State<T, E>> for Result<(Poll<Option<T>>, Poll<()>), E>

fn from(value: State<T, E>) -> Self

Converts to this type from the input type.

impl<T: Hash, E: Hash> Hash for State<T, E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq, E: PartialEq> PartialEq for State<T, E>

fn eq(&self, other: &State<T, E>) -> 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, E: Copy> Copy for State<T, E>

impl<T: Eq, E: Eq> Eq for State<T, E>

impl<T, E> StructuralPartialEq for State<T, E>