Enum Instruction

pub enum Instruction<T> {
    Mutate(Operation<T>),
    Yield,
}

Control flow involving a stack.

Instructions are used to convert an iterator of Operations into an iterator of stack contents.

Variants

Mutate(Operation<T>)

Mutate the stack with the given operation.

Yield

Yield the contents of the stack.

Implementations

impl<T> Instruction<T>

pub const Pop: Instruction<T>

Shorthand for wrapping a Pop operation in Mutate.

pub const fn Push(val: T) -> Instruction<T>

Shorthand for wrapping a Push operation in Mutate.

pub fn into_operation(self) -> Option<Operation<T>>

Returns the operation, if mutating.

Examples

use stacking_iterator::prelude::*;

assert_eq!(Instruction::Push(1).into_operation(), Some(Operation::Push(1)));
assert_eq!(<Instruction<()>>::Pop.into_operation(), Some(Operation::Pop));
assert_eq!(<Instruction<()>>::Yield.into_operation(), None);

pub fn as_operation(&self) -> Option<&Operation<T>>

Returns a reference to the operation, if mutating.

Examples

use stacking_iterator::prelude::*;

assert_eq!(Instruction::Push(1).as_operation(), Some(&Operation::Push(1)));
assert_eq!(<Instruction<()>>::Pop.as_operation(), Some(&Operation::Pop));
assert_eq!(<Instruction<()>>::Yield.as_operation(), None);

Trait Implementations

impl<T: Clone> Clone for Instruction<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Instruction<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Instruction<T>

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> PartialEq for Instruction<T>

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

impl<T: Eq> Eq for Instruction<T>

impl<T> StructuralPartialEq for Instruction<T>