Enum xaynet::state_machine::StateMachine

pub enum StateMachine<R> {
    Idle(PhaseState<R, Idle>),
    Sum(PhaseState<R, Sum>),
    Update(PhaseState<R, Update>),
    Sum2(PhaseState<R, Sum2>),
    Unmask(PhaseState<R, Unmask>),
    Error(PhaseState<R, StateError>),
    Shutdown(PhaseState<R, Shutdown>),
}

The state machine with all its states.

Variants

Idle(PhaseState<R, Idle>)

Sum(PhaseState<R, Sum>)

Update(PhaseState<R, Update>)

Sum2(PhaseState<R, Sum2>)

Unmask(PhaseState<R, Unmask>)

Error(PhaseState<R, StateError>)

Shutdown(PhaseState<R, Shutdown>)

Implementations

impl<R> StateMachine<R> where
    PhaseState<R, Idle>: Phase<R> + Purge<R>,
    PhaseState<R, Sum>: Phase<R> + Purge<R>,
    PhaseState<R, Update>: Phase<R> + Purge<R>,
    PhaseState<R, Sum2>: Phase<R> + Purge<R>,
    PhaseState<R, Unmask>: Phase<R> + Purge<R>,
    PhaseState<R, StateError>: Phase<R> + Purge<R>,
    PhaseState<R, Shutdown>: Phase<R> + Purge<R>, 

pub fn new(
    pet_settings: PetSettings,
    mask_settings: MaskSettings,
    model_settings: ModelSettings
) -> Result<(Self, RequestSender<R>, EventSubscriber), InitError>

Creates a new state machine with the initial state Idle.

Errors

Fails if there is insufficient system entropy to generate secrets.

    Note: If the StateMachine is created via
    PhaseState::::new(...) it must be ensured that the module
    
    sodiumoxide::init() has been initialized beforehand.

For example:

sodiumoxide::init().unwrap();
let state_machine =
    StateMachine::from(PhaseState::<R, Idle>::new(coordinator_state, req_receiver));

pub async fn next(self) -> Option<Self>

Moves the StateMachine to the next state and consumes the current one. Returns the next state or None if the StateMachine reached the state Shutdown.

pub async fn run(__arg0: Self) -> Option<()>

Runs the state machine until it shuts down. The StateMachine shuts down once all RequestSender have been dropped.

Trait Implementations

impl<R> From<PhaseState<R, Idle>> for StateMachine<R>

fn from(original: PhaseState<R, Idle>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, Shutdown>> for StateMachine<R>

fn from(original: PhaseState<R, Shutdown>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, StateError>> for StateMachine<R>

fn from(original: PhaseState<R, StateError>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, Sum>> for StateMachine<R>

fn from(original: PhaseState<R, Sum>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, Sum2>> for StateMachine<R>

fn from(original: PhaseState<R, Sum2>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, Unmask>> for StateMachine<R>

fn from(original: PhaseState<R, Unmask>) -> StateMachine<R>

Performs the conversion.

impl<R> From<PhaseState<R, Update>> for StateMachine<R>

fn from(original: PhaseState<R, Update>) -> StateMachine<R>

Performs the conversion.