Struct GrammarRule 

pub struct GrammarRule {
    pub name: String,
    pub expr: GrammarExpr,
    pub kind: RuleKind,
    pub concept: Option<String>,
    pub doc: Option<String>,
}

A named grammar rule.

Fields

name: String

Rule name.

expr: GrammarExpr

Rule expression.

kind: RuleKind

Rule participation kind.

concept: Option<String>

Optional concept-ontology alignment.

doc: Option<String>

Optional free-text documentation or comment.

Implementations

impl GrammarRule

pub fn new(name: impl Into<String>, expr: GrammarExpr) -> Self

Builds a normal grammar rule.

pub const fn with_kind(self, kind: RuleKind) -> Self

Returns this rule with a different rule kind.

pub fn with_concept(self, concept: impl Into<String>) -> Self

Returns this rule with concept-ontology alignment.

pub fn with_doc(self, doc: impl Into<String>) -> Self

Returns this rule with documentation text.

pub fn name(&self) -> &str

Rule name.

pub const fn expr(&self) -> &GrammarExpr

Rule expression.

pub const fn kind(&self) -> RuleKind

Rule participation kind.

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

Concept-ontology alignment, when present.

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

Rule documentation, when present.

Trait Implementations

impl Clone for GrammarRule

fn clone(&self) -> GrammarRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GrammarRule

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

Formats the value using the given formatter.

impl PartialEq for GrammarRule

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

impl StructuralPartialEq for GrammarRule