Skip to main content

FsmBuilder

Struct FsmBuilder 

Source
pub struct FsmBuilder<S: Clone + Eq + Hash + 'static, D: Clone + 'static, M: 'static> { /* private fields */ }
Expand description

Builder for a closure-driven FSM.

When(Idle) { case Go => goto(Running) using d+1 }
When(Running) { case Stop => goto(Idle) }
WhenUnhandled { case _ => stay() }
OnTransition { case Idle -> Running => log("starting") }
OnTermination { case _ => log("done") }

Each when_state / whenever handler returns:

  • Some(FsmTransition) to transition.
  • None to fall through to whenever, then to drop the message.

Implementations§

Source§

impl<S, D, M> FsmBuilder<S, D, M>
where S: Clone + Eq + Hash + 'static, D: Clone + 'static, M: 'static,

Source

pub fn new() -> Self

Source

pub fn start_with(self, state: S, data: D) -> Self

Source

pub fn when_state<F>(self, state: S, handler: F) -> Self
where F: FnMut(&S, &D, M) -> Option<FsmTransition<S, D>> + Send + 'static,

Register a per-state handler. Overrides any existing handler for the same state.

Source

pub fn whenever<F>(self, handler: F) -> Self
where F: FnMut(&S, &D, M) -> Option<FsmTransition<S, D>> + Send + 'static,

Fallback handler. Runs when the per-state handler returns None.

Source

pub fn on_transition<F>(self, hook: F) -> Self
where F: FnMut(&S, &S) + Send + 'static,

Source

pub fn on_termination<F>(self, hook: F) -> Self
where F: FnMut(&S, &D) + Send + 'static,

Source

pub fn build(self) -> Fsm<S, D, M>

Trait Implementations§

Source§

impl<S, D, M> Default for FsmBuilder<S, D, M>
where S: Clone + Eq + Hash + 'static, D: Clone + 'static, M: 'static,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<S, D, M> Freeze for FsmBuilder<S, D, M>
where S: Freeze, D: Freeze,

§

impl<S, D, M> !RefUnwindSafe for FsmBuilder<S, D, M>

§

impl<S, D, M> Send for FsmBuilder<S, D, M>
where S: Send, D: Send,

§

impl<S, D, M> !Sync for FsmBuilder<S, D, M>

§

impl<S, D, M> Unpin for FsmBuilder<S, D, M>
where S: Unpin, D: Unpin,

§

impl<S, D, M> UnsafeUnpin for FsmBuilder<S, D, M>
where S: UnsafeUnpin, D: UnsafeUnpin,

§

impl<S, D, M> !UnwindSafe for FsmBuilder<S, D, M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more