Struct StateMut 

pub struct StateMut<G, T, S>
where
    G: DerefMut<Target = SharedValue<T>>,
{ /* private fields */ }

Mutable typed view into shared state.

Transitions performed through this guard update an internal pending state. When the guard is dropped, that pending state is committed back to the shared container.

The returned guard is used through the generic State alias SMutView, so implementation methods can keep the same State<S, Self, Current> receiver shape they use for owned values:

{
    let connected = shared.borrow_mut::<Connected>()?;
    let authenticated = magicstatemachines::transition!(
        connected,
        "alice".to_owned(),
    );
    drop(authenticated); // shared state is now `Authenticated`
}

The commit happens when the final guard state is dropped. Constructing a transition call object is not a commit by itself.

Trait Implementations

impl<G, T, S> Deref for StateMut<G, T, S>

where G: DerefMut<Target = SharedValue<T>>,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<G, T, S> DerefMut for StateMut<G, T, S>

where G: DerefMut<Target = SharedValue<T>>,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<G, T, S> Drop for StateMut<G, T, S>

where G: DerefMut<Target = SharedValue<T>>,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.