Enum PushStep 

pub enum PushStep<CanPend>
where
    CanPend: Toggle,
{
    Done,
    Pending(CanPend),
}

The result of pushing an item into a Push.

PushStep represents the two possible outcomes when pushing into a pipeline:

• Done: The item was successfully consumed.
• Pending(can_pend): The push could not accept the item yet (async backpressure).

The CanPend type parameter uses Toggle to statically encode whether pending is possible. When CanPend = No, the Pending variant cannot be constructed, and the push is guaranteed to always accept items immediately.

Variants

Done

The item was successfully consumed.

Pending(CanPend)

The push is not ready yet (only possible when CanPend = Yes).

Implementations

impl<CanPend> PushStep<CanPend>

where CanPend: Toggle,

pub fn pending() -> Self

Creates a new PushStep::Pending, or panics if CanPend = No.

pub const fn is_done(&self) -> bool

Returns true if the step is PushStep::Done.

pub const fn is_pending(&self) -> bool

Returns true if the step is PushStep::Pending.

pub fn try_convert_into<NewPend>(self) -> Option<PushStep<NewPend>>

where NewPend: Toggle,

Tries to convert the CanPend type parameter, returning None if the conversion is invalid.

pub fn convert_into<NewPend>(self) -> PushStep<NewPend>

where NewPend: Toggle,

Converts the CanPend type parameter, panicking if the conversion is invalid.

Trait Implementations

impl<CanPend> Clone for PushStep<CanPend>

where CanPend: Toggle + Clone,

fn clone(&self) -> PushStep<CanPend>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CanPend> Debug for PushStep<CanPend>

where CanPend: Toggle + Debug,

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

Formats the value using the given formatter.

impl<CanPend> Hash for PushStep<CanPend>

where CanPend: Toggle + Hash,

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<CanPend> Ord for PushStep<CanPend>

where CanPend: Toggle + Ord,

fn cmp(&self, other: &PushStep<CanPend>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<CanPend> PartialEq for PushStep<CanPend>

where CanPend: Toggle + PartialEq,

fn eq(&self, other: &PushStep<CanPend>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<CanPend> PartialOrd for PushStep<CanPend>

where CanPend: Toggle + PartialOrd,

fn partial_cmp(&self, other: &PushStep<CanPend>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<CanPend> Copy for PushStep<CanPend>

where CanPend: Toggle + Copy,

impl<CanPend> Eq for PushStep<CanPend>

where CanPend: Toggle + Eq,

impl<CanPend> StructuralPartialEq for PushStep<CanPend>

where CanPend: Toggle,