pub struct State<T> where
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
impl<T> State<T> where
T: StateData,
impl<T> State<T> where
T: StateData,
pub fn on_update(s: T) -> RunCriteriaDescriptor
pub fn on_inactive_update(s: T) -> RunCriteriaDescriptor
pub fn on_in_stack_update(s: T) -> RunCriteriaDescriptor
pub fn on_enter(s: T) -> RunCriteriaDescriptor
pub fn on_exit(s: T) -> RunCriteriaDescriptor
pub fn on_pause(s: T) -> RunCriteriaDescriptor
pub fn on_resume(s: 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
pub 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) -> State<T>
pub 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, or if the given state
matches the
current state
pub 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
pub 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, or if the given state
matches the
current state
pub 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
pub 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
pub 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
pub 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
pub 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
pub fn current(&self) -> &T
pub fn inactives(&self) -> &[T]ⓘNotable traits for &'_ [u8]impl Read for &'_ [u8]impl Write for &'_ mut [u8]
Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Convert 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 more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more