Struct SectionRules

pub(crate) struct SectionRules<T: Keyword> {
    rules: Vec<Option<TokenFmt<T>>>,
}

Describe the rules for one section of a document.

The rules are represented as a mapping from token index to rules::TokenFmt.

Fields

rules: Vec<Option<TokenFmt<T>>>

A set of rules for decoding a series of tokens into a Section object. Each element of this array corresponds to the token with the corresponding index values.

When an array element is None, the corresponding keyword is not allowed in this kind section. Otherwise, the array element is a TokenFmt describing how many of the corresponding token may appear, and what they need to look like.

Implementations

impl<T: Keyword> SectionRules<T>

pub(crate) fn builder() -> SectionRulesBuilder<T>

Create a new builder for a SectionRules with no rules.

By default, no Keyword is allowed by this SectionRules.

fn parse_unverified<'a, I>( &self, tokens: I, section: &mut Section<'a, T>, ) -> Result<()>

where I: Iterator<Item = Result<Item<'a, T>>>,

Parse a stream of tokens into a Section object without (fully) verifying them.

Some errors are detected early, but others only show up later when we validate more carefully.

fn validate(&self, s: &Section<'_, T>) -> Result<()>

Check whether the tokens in a section we’ve parsed conform to these rules.

fn validate_objects(&self, s: &Section<'_, T>, kwd: T) -> Result<()>

Check all the base64-encoded objects on a given keyword.

We use this to validate objects on unrecognized items, since otherwise nothing would check that they are well-formed.

pub(crate) fn parse<'a, I>(&self, tokens: I) -> Result<Section<'a, T>>

where I: Iterator<Item = Result<Item<'a, T>>>,

Parse a stream of tokens into a validated section.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.