Struct Frame 

pub struct Frame {
    pub command: DriveCommand,
    pub next_transition_ms: Option<u32>,
    pub instruction_index: Option<usize>,
    pub finished: bool,
}

One output frame produced by Runner::poll.

Fields

command: DriveCommand

Driver command for the current time.

next_transition_ms: Option<u32>

Earliest wrapping u32 clock value at which output may change.

While this is Some(deadline), Self::command is guaranteed not to change before deadline, so the caller may sleep until then. Compare or wait using wrapping arithmetic rather than absolute < / >. A deadline equal to the current poll time requests another poll at that same time to drain an immediate control-flow transition. None means there is no active or pending transition because the runner is idle or has finished.

instruction_index: Option<usize>

Active instruction index in the current cycle.

finished: bool

true only when a finite program has completed.

This is edge-triggered, not a latched state: it is set on the single Runner::poll that observes the end of the program, which also stops the runner. Later polls return an idle frame with finished == false. Act on completion when you first see it rather than polling for it.

Implementations

impl Frame

pub const fn is_idle(&self) -> bool

Returns true for an ordinary idle frame with no active instruction.

The one-shot completion frame is not considered idle; it instead reports Self::is_finished.

pub const fn is_active(&self) -> bool

Returns true when an instruction is active.

pub const fn is_finished(&self) -> bool

Returns true when a finite program reached the end.

pub const fn command(&self) -> DriveCommand

Convenience getter for driver command.

pub const fn next_transition_ms(&self) -> Option<u32>

Return the earliest wrapping clock value at which output may change.

See Frame::next_transition_ms for the sleep and same-timestamp polling contract.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Frame

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame