Struct TokenFmt

pub(crate) struct TokenFmt<T: Keyword> {
    kwd: T,
    min_args: Option<usize>,
    max_args: Option<usize>,
    required: bool,
    may_repeat: bool,
    obj: ObjKind,
}

A set of restrictions to place on Items for a single keyword.

These are built by the TokenFmtBuilder API.

Fields

kwd: T

Which keyword is being restricted?

min_args: Option<usize>

If present, a lower bound on how many arguments may be present.

max_args: Option<usize>

If present, an upper bound on how many arguments may be present.

required: bool

If true, then at least one of this Item must appear.

may_repeat: bool

If false, then no more than one this Item may appear.

obj: ObjKind

May this Item have an object? Must it?

Implementations

impl<T: Keyword> TokenFmt<T>

pub(crate) fn kwd(&self) -> T

Return the keyword that this rule restricts.

fn item_matches_args(&self, item: &Item<'_, T>) -> Result<()>

Check whether a single Item matches this TokenFmt rule, with respect to its number of arguments.

fn item_matches_obj(&self, item: &Item<'_, T>) -> Result<()>

Check whether a single Item matches a TokenFmt rule, with respect to its object’s presence and type.

pub(crate) fn check_item(&self, item: &Item<'_, T>) -> Result<()>

Check whether a single item has the right number of arguments and object.

pub(crate) fn check_multiplicity(&self, items: &[Item<'_, T>]) -> Result<()>

Check whether this kind of item may appear this many times.

Trait Implementations

impl<T: Clone + Keyword> Clone for TokenFmt<T>

fn clone(&self) -> TokenFmt<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Keyword> From<TokenFmtBuilder<T>> for TokenFmt<T>

fn from(builder: TokenFmtBuilder<T>) -> Self

Converts to this type from the input type.