Trait xaynet::state_machine::phases::Phase

pub trait Phase<R> {
    const NAME: PhaseName;

#[must_use]    fn run<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    fn next(self) -> Option<StateMachine<R>>;
}

A trait that must be implemented by a state in order to move to a next state.

Associated Constants

const NAME: PhaseName

Name of the current phase

Loading content...

Required methods

#[must_use]fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Run this phase to completion

fn next(self) -> Option<StateMachine<R>>

Moves from this state to the next state.

Loading content...

Implementors

impl<R> Phase<R> for PhaseState<R, StateError> where
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn next(self) -> Option<StateMachine<R>>

Moves from the error state to the next state.

See the module level documentation for more details.

impl<R> Phase<R> for PhaseState<R, Idle> where
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Moves from the idle state to the next state.

See the module level documentation for more details.

fn next(self) -> Option<StateMachine<R>>

impl<R> Phase<R> for PhaseState<R, Shutdown> where
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Shuts down the StateMachine.

See the module level documentation for more details.

fn next(self) -> Option<StateMachine<R>>

impl<R> Phase<R> for PhaseState<R, Sum> where
    Self: Handler<R> + Purge<R>,
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Run the sum phase.

See the module level documentation for more details.

fn next(self) -> Option<StateMachine<R>>

impl<R> Phase<R> for PhaseState<R, Sum2> where
    Self: Purge<R> + Handler<R>,
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Run the sum2 phase

See the module level documentation for more details.

fn next(self) -> Option<StateMachine<R>>

Moves from the sum2 state to the next state.

See the module level documentation for more details.

impl<R> Phase<R> for PhaseState<R, Unmask> where
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Run the unmasking phase

fn next(self) -> Option<StateMachine<R>>

Moves from the unmask state to the next state.

See the module level documentation for more details.

impl<R> Phase<R> for PhaseState<R, Update> where
    Self: Handler<R> + Purge<R>,
    R: Send, 

const NAME: PhaseName

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), StateError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Moves from the update state to the next state.

See the module level documentation for more details.

fn next(self) -> Option<StateMachine<R>>

Loading content...