Struct RuntimeFsm 

pub struct RuntimeFsm { /* private fields */ }

Executable runtime mirror of the generated typestate API.

Implementations

impl RuntimeFsm

Runtime state-machine construction, inspection, and advancement.

pub const fn new() -> Self

Creates an FSM in the grammar’s initial state.

pub const fn state(&self) -> RuntimeState

Returns the current runtime phase.

pub const fn choice(&self) -> ChoiceKind

Returns who selects transitions in the current phase.

pub const fn dual_choice(&self) -> ChoiceKind

Returns the current phase’s choice as seen by the peer.

pub fn event_choice(&self, event: Event) -> Option<ChoiceKind>

Returns the direction of one legal event from the current state.

pub fn dual_event_choice(&self, event: Event) -> Option<ChoiceKind>

Returns the direction of one legal event for the dual role.

pub fn step(&mut self, event: Event) -> Result<(), TransitionError>

Advances the FSM with event without changing it on error.

pub fn step_projected<Message>( &mut self, message: &Message, project: impl FnOnce(RuntimeState, &Message) -> Option<Event>, ) -> Result<Event, ProjectionError>

Projects a wire message using the current state, then advances.

The projector is state-aware because one wire message can denote different protocol events in nested or mixed sessions.

Trait Implementations

impl Clone for RuntimeFsm

fn clone(&self) -> RuntimeFsm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RuntimeFsm

impl Debug for RuntimeFsm

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

Formats the value using the given formatter.

impl Default for RuntimeFsm

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RuntimeFsm

impl PartialEq for RuntimeFsm

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RuntimeFsm