Struct Hierarchical 

pub struct Hierarchical<P, C> { /* private fields */ }

Parent and child state machines with child-first event routing and retained shallow history.

Deactivating a child does not reset it. Reactivating it therefore resumes its previous state; reset_child explicitly replaces that history.

Implementations

impl<P, C> Hierarchical<P, C>

pub const fn new(parent: P, child: C) -> Self

Creates a hierarchy with an inactive child.

pub const fn new_active(parent: P, child: C) -> Self

Creates a hierarchy whose child starts active.

pub fn activate_child(&mut self)

Activates the child, preserving its previous state.

pub fn deactivate_child(&mut self)

Deactivates the child while preserving shallow history.

pub fn reset_child(&mut self, child: C)

Replaces the child and activates its new initial state.

pub const fn child_is_active(&self) -> bool

Returns true when the child is active.

pub fn parent(&self) -> &P

Returns the parent machine.

pub fn parent_mut(&mut self) -> &mut P

Returns the parent machine mutably.

pub fn child(&self) -> &C

Returns the child machine.

pub fn child_mut(&mut self) -> &mut C

Returns the child machine mutably.

pub fn process_event<E, FC, FP>( &mut self, event: E, child_dispatch: FC, parent_dispatch: FP, ) -> HierarchicalDispatch

where E: Clone, C: Terminated, FC: FnMut(&mut C, E) -> bool, FP: FnMut(&mut P, E) -> bool,

Routes an event to the active child first and bubbles unhandled events to the parent.

pub fn process_event_with_completion<E, FC, FP, FT>( &mut self, event: E, child_dispatch: FC, parent_dispatch: FP, child_completion: FT, ) -> HierarchicalDispatch

where E: Clone, C: Terminated, FC: FnMut(&mut C, E) -> bool, FP: FnMut(&mut P, E) -> bool, FT: FnMut(&mut P) -> bool,

Routes an event like process_event and propagates child termination to a parent completion callback.

When the callback handles completion, the child is deactivated while retaining its state as shallow history.