Struct Generator 

pub struct Generator { /* private fields */ }

A single-lane generator that yields a fixed sequence of values on demand.

Models the yield-to-driver surface of generator control: each Generator::next_step resumes the generator and hands back the next value.

Examples

use sim_kernel::{Ref, Symbol};
use sim_lib_control::{Generator, GeneratorStep};

let one = Ref::Symbol(Symbol::new("one"));
let mut generator = Generator::new(vec![one.clone()]);
assert_eq!(generator.next_step(), GeneratorStep::Yielded(one));
assert_eq!(generator.next_step(), GeneratorStep::Exhausted);
assert!(generator.is_exhausted());

Implementations

impl Generator

pub fn new(values: Vec<Ref>) -> Self

Builds a generator that yields values in order.

pub fn next_step(&mut self) -> GeneratorStep

Advances the generator, returning the next GeneratorStep::Yielded value or GeneratorStep::Exhausted once drained.

pub fn is_exhausted(&self) -> bool

Returns whether every value has been yielded.

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Generator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl Eq for Generator

impl PartialEq for Generator

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