Struct enso_automata::symbol::Symbol

pub struct Symbol {
    pub index: SymbolIndex,
    pub name: String,
}

An input symbol to a finite automaton.

Fields

index: SymbolIndex

name: String

Implementations

impl Symbol

pub fn eof() -> Self

End of line symbol.

pub fn invalid() -> Self

Invalid symbol.

pub fn null() -> Self

Null symbol.

pub fn min() -> Self

The minimum symbol value.

pub fn max() -> Self

The maximum symbol value.

pub fn new(index: SymbolIndex) -> Self

Constructor.

pub fn new_named(index: SymbolIndex, name: impl Into<String>) -> Self

Named constructor.

pub fn next(&self) -> Option<Self>

Next symbol, if any.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Self

Returns the “default value” for a type.

impl Display for Symbol

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

Formats the value using the given formatter.

impl From<&'_ Symbol> for Symbol

fn from(symbol: &Symbol) -> Self

Performs the conversion.

impl From<char> for Symbol

fn from(ch: char) -> Symbol

Performs the conversion.

impl From<u32> for Symbol

fn from(index: u32) -> Symbol

Performs the conversion.

impl From<u64> for Symbol

fn from(index: u64) -> Symbol

Performs the conversion.

impl Hash for Symbol

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Symbol

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Symbol> for Symbol

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Symbol> for Symbol

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 Eq for Symbol