Struct stateright::Path

pub struct Path<State, Action>(_);

A path of states including actions. i.e. state --action--> state ... --action--> state.

You can convert to a Vec<_> with path.into_vec(). If you only need the actions, then use path.into_actions().

Implementations

impl<State, Action> Path<State, Action>

pub fn from_actions<'a, M>( model: &M, init_state: State, actions: impl IntoIterator<Item = &'a Action> ) -> Option<Self>where M: Model<State = State, Action = Action>, State: PartialEq, Action: PartialEq + 'a,

Constructs a path from a model, initial state, and a sequence of actions. Panics for inputs unreachable via the model.

pub fn last_state(&self) -> &State

Extracts the last state.

pub fn into_states(self) -> Vec<State>

Extracts the states.

pub fn into_actions(self) -> Vec<Action>

Extracts the actions.

pub fn into_vec(self) -> Vec<(State, Option<Action>)>

Convenience method for Into<Vec<_>>.

pub fn encode(&self) -> Stringwhere State: Hash,

Encodes the path as a sequence of opaque “fingerprints” delimited by forward slash (/) characters.

Trait Implementations

impl<State: Clone, Action: Clone> Clone for Path<State, Action>

fn clone(&self) -> Path<State, Action>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State: Debug, Action: Debug> Debug for Path<State, Action>

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

Formats the value using the given formatter.

impl<State, Action> Display for Path<State, Action>where Action: Debug, State: Debug,

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

Formats the value using the given formatter.

impl<State, Action> From<Path<State, Action>> for Vec<(State, Option<Action>)>

fn from(source: Path<State, Action>) -> Self

Converts to this type from the input type.

impl<State: Hash, Action: Hash> Hash for Path<State, Action>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<State: Ord, Action: Ord> Ord for Path<State, Action>

fn cmp(&self, other: &Path<State, Action>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<State: PartialEq, Action: PartialEq> PartialEq<Path<State, Action>> for Path<State, Action>

fn eq(&self, other: &Path<State, Action>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<State: PartialOrd, Action: PartialOrd> PartialOrd<Path<State, Action>> for Path<State, Action>

fn partial_cmp(&self, other: &Path<State, Action>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<State: Eq, Action: Eq> Eq for Path<State, Action>

impl<State, Action> StructuralEq for Path<State, Action>

impl<State, Action> StructuralPartialEq for Path<State, Action>