pub struct State<T: StateData> { /* private fields */ }
Expand description
Stack based state machine
This state machine has four operations: Push, Pop, Set and Replace.
- Push pushes a new state to the state stack, pausing the previous state
- Pop removes the current state, and unpauses the last paused state
- Set replaces the active state with a new one
- Replace unwinds the state stack, and replaces the entire stack with a single new state
Implementations§
source§impl<T> State<T>where
T: StateData,
impl<T> State<T>where
T: StateData,
pub fn on_update(pred: T) -> RunCriteriaDescriptor
pub fn on_inactive_update(pred: T) -> RunCriteriaDescriptor
pub fn on_in_stack_update(pred: T) -> RunCriteriaDescriptor
pub fn on_enter(pred: T) -> RunCriteriaDescriptor
pub fn on_exit(pred: T) -> RunCriteriaDescriptor
pub fn on_pause(pred: T) -> RunCriteriaDescriptor
pub fn on_resume(pred: T) -> RunCriteriaDescriptor
pub fn on_update_set(s: T) -> SystemSet
pub fn on_inactive_update_set(s: T) -> SystemSet
pub fn on_enter_set(s: T) -> SystemSet
pub fn on_exit_set(s: T) -> SystemSet
pub fn on_pause_set(s: T) -> SystemSet
pub fn on_resume_set(s: T) -> SystemSet
sourcepub fn get_driver() -> SystemSet
pub fn get_driver() -> SystemSet
Creates a driver set for the State.
Important note: this set must be inserted before all other state-dependant sets to work properly!
pub fn new(initial: T) -> Self
sourcepub fn set(&mut self, state: T) -> Result<(), StateError>
pub fn set(&mut self, state: T) -> Result<(), StateError>
Schedule a state change that replaces the active state with the given state.
This will fail if there is a scheduled operation, pending transition, or if the given
state
matches the current state
sourcepub fn overwrite_set(&mut self, state: T) -> Result<(), StateError>
pub fn overwrite_set(&mut self, state: T) -> Result<(), StateError>
Same as Self::set
, but if there is already a next state, it will be overwritten
instead of failing
sourcepub fn replace(&mut self, state: T) -> Result<(), StateError>
pub fn replace(&mut self, state: T) -> Result<(), StateError>
Schedule a state change that replaces the full stack with the given state.
This will fail if there is a scheduled operation, pending transition, or if the given
state
matches the current state
sourcepub fn overwrite_replace(&mut self, state: T) -> Result<(), StateError>
pub fn overwrite_replace(&mut self, state: T) -> Result<(), StateError>
Same as Self::replace
, but if there is already a next state, it will be overwritten
instead of failing
sourcepub fn push(&mut self, state: T) -> Result<(), StateError>
pub fn push(&mut self, state: T) -> Result<(), StateError>
Same as Self::set
, but does a push operation instead of a next operation
sourcepub fn overwrite_push(&mut self, state: T) -> Result<(), StateError>
pub fn overwrite_push(&mut self, state: T) -> Result<(), StateError>
Same as Self::push
, but if there is already a next state, it will be overwritten
instead of failing
sourcepub fn pop(&mut self) -> Result<(), StateError>
pub fn pop(&mut self) -> Result<(), StateError>
Same as Self::set
, but does a pop operation instead of a set operation
sourcepub fn overwrite_pop(&mut self) -> Result<(), StateError>
pub fn overwrite_pop(&mut self) -> Result<(), StateError>
Same as Self::pop
, but if there is already a next state, it will be overwritten
instead of failing
sourcepub fn restart(&mut self) -> Result<(), StateError>
pub fn restart(&mut self) -> Result<(), StateError>
Schedule a state change that restarts the active state. This will fail if there is a scheduled operation or a pending transition
sourcepub fn overwrite_restart(&mut self)
pub fn overwrite_restart(&mut self)
Same as Self::restart
, but if there is already a scheduled state operation,
it will be overwritten instead of failing
pub fn current(&self) -> &T
pub fn inactives(&self) -> &[T] ⓘ
sourcepub fn clear_schedule(&mut self)
pub fn clear_schedule(&mut self)
Clears the scheduled state operation.
Trait Implementations§
impl<T: StateData> Resource for State<T>where
Self: Send + Sync + 'static,
Auto Trait Implementations§
impl<T> RefUnwindSafe for State<T>where
T: RefUnwindSafe,
impl<T> Send for State<T>
impl<T> Sync for State<T>
impl<T> Unpin for State<T>where
T: Unpin,
impl<T> UnwindSafe for State<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresource§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more