Enum parol::grammar::symbol::Symbol

pub enum Symbol {
    N(String, SymbolAttribute, Option<UserDefinedTypeName>),
    T(Terminal),
    S(ScannerIndex),
    Push(ScannerIndex),
    Pop,
}

A grammar symbol with different specificities

Variants

N(String, SymbolAttribute, Option<UserDefinedTypeName>)

Non-terminal symbol, Meta symbol of the grammar.

T(Terminal)

Terminal symbol of the grammar.

S(ScannerIndex)

Instruction to switch scanner state

Push(ScannerIndex)

Instruction to push the index of the current scanner and switch to a scanner configuration with the given index

Pop

Instruction to pop the index of the scanner pushed before and switch to the scanner configuration with that index

Implementations

impl Symbol

pub fn n(n: &str) -> Self

Creates a non-terminal symbol

pub fn e() -> Self

Creates a end-of-input terminal symbol

pub fn s(s: usize) -> Self

Creates a scanner index

pub fn is_t(&self) -> bool

Checks if self is a terminal

pub fn is_n(&self) -> bool

Checks if self is a non-terminal

pub fn is_end(&self) -> bool

Checks if self is a end-of-input terminal

pub fn is_switch(&self) -> bool

Checks if self is a scanner switch instruction

pub fn get_t(&self) -> Option<Terminal>

Returns a terminal if available

pub fn get_t_ref(&self) -> Option<&Terminal>

Returns a terminal reference if available

pub fn get_n(&self) -> Option<String>

Returns a non-terminal if available

pub fn get_n_ref(&self) -> Option<&str>

Returns a non-terminal reference if available

pub fn attribute(&self) -> SymbolAttribute

Get the symbol attribute or a default value

pub fn format<R, S>( &self, scanner_state_resolver: &R, user_type_resolver: &S, ) -> Result<String>

where R: Fn(&[usize]) -> String, S: Fn(&str) -> Option<String>,

Formats self with the help of a scanner state resolver

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

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

Formats the value using the given formatter.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Symbol

fn cmp(&self, other: &Symbol) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Symbol

fn eq(&self, other: &Symbol) -> 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 PartialOrd for Symbol

fn partial_cmp(&self, other: &Symbol) -> 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 TryFrom<Factor> for Symbol

type Error = Error

The type returned in the event of a conversion error.

fn try_from(factor: Factor) -> Result<Self>

Performs the conversion.

impl Eq for Symbol

impl StructuralPartialEq for Symbol