Struct StateId 

pub struct StateId(pub u32);

Dense integer identifier for an automaton state.

StateId is the fast state representation used by crate::Explicit, crate::Memo, and deterministic runners. IDs are dense, starting at zero, so they can be used to index vectors and bitsets.

Most users should create states with crate::ExplicitBuilder::new_state or crate::Interner::intern rather than constructing StateId directly. The one special value is StateId::STUCK, which is reserved for rejected subtrees and must not be used as an ordinary state.

Tuple Fields

0: u32

Implementations

impl StateId

pub const STUCK: StateId

Sentinel meaning “this subtree has no valid state”.

Deterministic runs store this value in their side table when a node is rejected. Builders and interners never allocate it as a real state.

pub fn index(self) -> usize

Convert this state ID to a vector or bitset index.

Do not call this on StateId::STUCK unless the surrounding code has explicitly chosen to handle the sentinel as usize::MAX.

pub fn is_stuck(self) -> bool

Return whether this ID is the stuck sentinel.

Trait Implementations

impl Clone for StateId

fn clone(&self) -> StateId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StateId

impl Debug for StateId

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

Formats the value using the given formatter.

impl Default for StateId

fn default() -> StateId

Returns the “default value” for a type.

impl Eq for StateId

impl Hash for StateId

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 Ord for StateId

fn cmp(&self, other: &StateId) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StateId

fn eq(&self, other: &StateId) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for StateId

fn partial_cmp(&self, other: &StateId) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for StateId