Enum GeneratorResult

#[repr(u8)]
pub enum GeneratorResult {
    Stopped = 0,
    Complete = 1,
}

The result of generator runs.

A run can either run to completion, and no new values will be produced, or it can be stopped. In case it is stopped there might be more values available that can be obtained by calling Generator::run again.

Variants

Stopped = 0

Returned from Generator::run when the generator was stopped because the output function returned ValueResult::Stop

Complete = 1

Returned from Generator::run when the generator has sent all values to the output function. When this has been returned the generator will never generate more values again.

Trait Implementations

impl Clone for GeneratorResult

fn clone(&self) -> GeneratorResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorResult

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

Formats the value using the given formatter.

impl From<bool> for GeneratorResult

fn from(b: bool) -> Self

Converts to this type from the input type.

impl Ord for GeneratorResult

fn cmp(&self, other: &GeneratorResult) -> 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 PartialEq for GeneratorResult

fn eq(&self, other: &GeneratorResult) -> 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 PartialOrd for GeneratorResult

fn partial_cmp(&self, other: &GeneratorResult) -> 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 Copy for GeneratorResult

impl Eq for GeneratorResult

impl StructuralPartialEq for GeneratorResult