Struct TokenFmtBuilder

pub struct TokenFmtBuilder<T: Keyword>(TokenFmt<T>);

Represents a TokenFmt under construction.

To construct a rule, create this type with Keyword::rule(), then call method on it to set its fields, and then pass it to SectionRules::add().

Example

// There must be exactly one "ROUTER" entry, with 5 or more arguments.
section_rules.add(D.rule().required().args(5..));

TODO: I’d rather have this be pub(crate), but I haven’t figured out how to make that work. There are complicated cascading side-effects.

Tuple Fields

0: TokenFmt<T>

Implementations

impl<T: Keyword> TokenFmtBuilder<T>

pub(crate) fn new(t: T) -> Self

Make a new TokenFmtBuilder with default behavior.

(By default, all arguments are allowed, the Item may appear 0 or 1 times, and it may not take an object.)

pub(crate) fn required(self) -> Self

Indicate that this Item is required.

By default, no item is required.

pub(crate) fn may_repeat(self) -> Self

Indicate that this Item may appear more than once.

By default, items may not repeat.

pub(crate) fn no_args(self) -> Self

Indicate that this Item takes no arguments.

By default, items may take any number of arguments.

pub(crate) fn args<R>(self, r: R) -> Self

where R: RangeBounds<usize>,

Indicate that this item takes a certain number of arguments.

The number of arguments is provided as a range, like 5...

pub(crate) fn obj_optional(self) -> Self

Indicate that this token takes an optional object.

By default, objects are not allowed.

pub(crate) fn obj_required(self) -> Self

Indicate that this token takes an required object.

By default, objects are not allowed.

Trait Implementations

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

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

Converts to this type from the input type.