Struct State

pub struct State {
    pub action: Option<Action>,
    pub counter: (Option<Counter>, Option<Counter>),
    /* private fields */
}

A state as part of a Machine.

Fields

action: Option<Action>

Take an action upon transitioning to this state.

counter: (Option<Counter>, Option<Counter>)

On transition to this state, update the machine’s two counters (A,B).

Implementations

impl State

pub fn new(t: EnumMap<Event, Vec<Trans>>) -> Self

Create a new State that transitions on the given Events.

Example:

use maybenot::state::*;
use maybenot::event::*;
use enum_map::enum_map;
let state = State::new(enum_map! {
    Event::PaddingSent => vec![Trans(1, 1.0)],
    Event::CounterZero => vec![Trans(2, 1.0)],
    _ => vec![],
});

This creates a state that transitions to state 1 on Event::PaddingSent and to state 2 on Event::CounterZero, both with 100% probability. All other events will not cause a transition. Note that state indexes are 0-based and determined by the order in which states are added to the Machine.

pub fn validate(&self, num_states: usize) -> Result<(), Error>

Validate that this state has acceptable transitions and that the distributions, if set, are valid. Note that num_states is the number of states in the machine, not the number of states in this state’s transitions. Called by Machine::new.

pub fn sample_state<R: RngCore>( &self, event: Event, rng: &mut R, ) -> Option<usize>

Sample a state to transition to given an Event.

pub fn get_transitions(&self) -> EnumMap<Event, Vec<Trans>>

Get the transitions for this state as an EnumMap of Event to vectors of Trans.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for State

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

Formats the value using the given formatter.

impl Serialize for State

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.