Skip to main content

Expr

Enum Expr 

Source
pub enum Expr {
    StringEq(String),
    StringEqCI(String),
    RuleRef(String),
    CharOf(String),
    Sequence(Vec<Expr>),
    Alternation(Vec<Expr>),
    Repetition(Box<Expr>),
    Optional(Box<Expr>),
    NotFollowedBy(Box<Expr>),
    SideCondition(Box<Expr>, &'static str),
}
Expand description

Intermediate representation of a BNF/EBNF expression. All instances are maintained in optimized form.

Variants§

§

StringEq(String)

A case-sensitive literal, formatted as "text".

§

StringEqCI(String)

A case-insensitive literal, formatted as "text"i.

§

RuleRef(String)

A reference to another named rule.

§

CharOf(String)

A character class, formatted as 'label'.

§

Sequence(Vec<Expr>)

Concatenation: A B C.

§

Alternation(Vec<Expr>)

Alternation: A | B | C.

§

Repetition(Box<Expr>)

Zero or more repetitions: { A }.

§

Optional(Box<Expr>)

Zero or one: [ A ].

§

NotFollowedBy(Box<Expr>)

Negative lookahead: !A.

§

SideCondition(Box<Expr>, &'static str)

A side-condition beyond the shown syntax: A ^1 (see Expr::side_conditions).

Implementations§

Source§

impl Expr

Source

pub fn empty() -> Expr

Matches nothing; omitted from formatted output. Represented as an empty Sequence rather than its own variant, since format_list already renders one as nothing.

Source

pub fn sequence(exprs: Vec<Expr>) -> Expr

Create a sequence, automatically flattening nested sequences.

Source

pub fn alternation(exprs: Vec<Expr>) -> Expr

Create an alternation, automatically flattening.

Source

pub fn repetition(expr: Expr) -> Expr

Create a repetition, dropping any hidden (Empty) elements first; an entirely-hidden inner expression vanishes rather than showing as { }.

Source

pub fn optional(expr: Expr) -> Expr

Create an optional, dropping any hidden (Empty) elements first; an entirely-hidden inner expression vanishes rather than showing as [ ].

Source

pub fn side_condition(expr: Expr, text: &'static str) -> Expr

Attach a side-condition to expr, reported as a numbered marker — see Expr::side_conditions.

Source

pub fn side_conditions(&self) -> Vec<&'static str>

This expression’s SideCondition texts, deduplicated by string equality, in first-occurrence order — the same order format numbers their ^1, ^2, … markers. Callers print these as footnotes after the formatted expression.

Source

pub fn format(&self, f: &mut dyn Write) -> Result

Format this expression as EBNF. Each SideCondition renders as a numbered marker (^1, ^2, …) rather than its text — see side_conditions for the footnotes to print alongside.

Trait Implementations§

Source§

impl Clone for Expr

Source§

fn clone(&self) -> Expr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Expr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Expr

Source§

impl PartialEq for Expr

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Expr

Auto Trait Implementations§

§

impl Freeze for Expr

§

impl RefUnwindSafe for Expr

§

impl Send for Expr

§

impl Sync for Expr

§

impl Unpin for Expr

§

impl UnsafeUnpin for Expr

§

impl UnwindSafe for Expr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.