Enum pushgen::TryReduction

pub enum TryReduction<T> {
    Complete(T),
    Partial(T),
}

The result value of a try_* reduction.

A try_* reduction can either be partial, producing an intermediate value, or complete. Partial reductions can for instance be created when trying to reduce a spuriously stopping generator.

Variants

Complete(T)

The reduction has completed, with the associated result.

Partial(T)

The reduction is only partially completed. The associated value should be used when trying to complete the reduction in the future.

Implementations

impl<T> TryReduction<T>

pub fn is_complete(&self) -> bool

Check if the reduction is complete.

Examples

Basic usage:

use pushgen::TryReduction;
let x = TryReduction::Complete(());
assert!(x.is_complete());
assert!(!x.is_partial());

pub fn is_partial(&self) -> bool

Check if the reduction is partial.

Examples

Basic usage:

use pushgen::TryReduction;
let x = TryReduction::Partial(());
assert!(x.is_partial());
assert!(!x.is_complete());

pub fn unwrap(self) -> T

Get the underlying value, no matter if it’s complete or partial.

Examples

Basic usage:

use pushgen::TryReduction;
let complete = TryReduction::Complete(1);
assert_eq!(complete.unwrap(), 1);
let partial = TryReduction::Partial(2);
assert_eq!(partial.unwrap(), 2);

Trait Implementations

impl<T: Clone> Clone for TryReduction<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TryReduction<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for TryReduction<T>

fn cmp(&self, other: &TryReduction<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<TryReduction<T>> for TryReduction<T>

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

fn partial_cmp(&self, other: &TryReduction<T>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Copy> Copy for TryReduction<T>

impl<T: Eq> Eq for TryReduction<T>

impl<T> StructuralEq for TryReduction<T>

impl<T> StructuralPartialEq for TryReduction<T>