pub struct CallbackRegistry<SM: StateMachine> { /* private fields */ }
Expand description
Callback registry for state machine events
This structure manages callbacks for state machine events including:
- State entry callbacks: triggered when entering a state
- State exit callbacks: triggered when leaving a state
- Transition callbacks: triggered during state transitions
Implementations§
Source§impl<SM: StateMachine> CallbackRegistry<SM>
impl<SM: StateMachine> CallbackRegistry<SM>
Sourcepub fn on_state_entry<F>(&mut self, state: SM::State, callback: F)
pub fn on_state_entry<F>(&mut self, state: SM::State, callback: F)
Register a callback for when entering a specific state
§Arguments
state
- The state to monitor for entrycallback
- The callback function to execute
Sourcepub fn on_state_exit<F>(&mut self, state: SM::State, callback: F)
pub fn on_state_exit<F>(&mut self, state: SM::State, callback: F)
Register a callback for when exiting a specific state
§Arguments
state
- The state to monitor for exitcallback
- The callback function to execute
Sourcepub fn on_transition<F>(
&mut self,
from_state: SM::State,
input: SM::Input,
callback: F,
)
pub fn on_transition<F>( &mut self, from_state: SM::State, input: SM::Input, callback: F, )
Register a callback for a specific transition
§Arguments
from_state
- The source stateinput
- The input that triggers the transitioncallback
- The callback function to execute
Sourcepub fn on_any_state_entry<F>(&mut self, callback: F)
pub fn on_any_state_entry<F>(&mut self, callback: F)
Register a global callback that triggers on any state entry
§Arguments
callback
- The callback function to execute
Sourcepub fn on_any_state_exit<F>(&mut self, callback: F)
pub fn on_any_state_exit<F>(&mut self, callback: F)
Register a global callback that triggers on any state exit
§Arguments
callback
- The callback function to execute
Sourcepub fn on_any_transition<F>(&mut self, callback: F)
pub fn on_any_transition<F>(&mut self, callback: F)
Register a global callback that triggers on any transition
§Arguments
callback
- The callback function to execute
Sourcepub fn callback_count(&self) -> usize
pub fn callback_count(&self) -> usize
Get the number of registered callbacks
Trait Implementations§
Source§impl<SM: StateMachine> Debug for CallbackRegistry<SM>
impl<SM: StateMachine> Debug for CallbackRegistry<SM>
Source§impl<SM: StateMachine> Default for CallbackRegistry<SM>
impl<SM: StateMachine> Default for CallbackRegistry<SM>
Auto Trait Implementations§
impl<SM> Freeze for CallbackRegistry<SM>
impl<SM> !RefUnwindSafe for CallbackRegistry<SM>
impl<SM> Send for CallbackRegistry<SM>
impl<SM> Sync for CallbackRegistry<SM>
impl<SM> Unpin for CallbackRegistry<SM>
impl<SM> !UnwindSafe for CallbackRegistry<SM>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more