Enum WalkState

pub enum WalkState<T: WalkStateUnit + Debug + Clone> {
    Begin,
    Intermediate(T),
    Finished(T),
}

WalkState contains all information required to traverse offer and expose chains in a tree tracing routes from any point back to their originating source. This includes in the most complex case traversing from a use to offer chain, back through to an expose chain.

Variants

Begin

Intermediate(T)

Finished(T)

Implementations

impl<T: WalkStateUnit + Debug + Clone> WalkState<T>

pub fn new() -> Self

Constructs a new WalkState representing the start of a walk.

pub fn at(state: T) -> Self

Constructs a new WalkState representing the start of a walk after a hard coded initial node. Used to represent framework state with static state definitions such as rights in directories or filters in events.

pub fn advance(&self, next_state: Option<T>) -> Result<Self, RoutingError>

Advances the WalkState if and only if the state passed satisfies the validation.

pub fn is_finished(&self) -> bool

Whether or not the state is Finished.

pub fn finalize(&self, state: Option<T>) -> Result<Self, RoutingError>

Finalizes the state preventing future modification, this is called when the walker arrives at a node with a source of Framework, Builtin, Namespace or Self. The provided |state| should always be the state at the CapabilitySource.

Trait Implementations

impl<T: Clone + WalkStateUnit + Debug + Clone> Clone for WalkState<T>

fn clone(&self) -> WalkState<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + WalkStateUnit + Debug + Clone> Debug for WalkState<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.