Expand description
Based on a set of rules, validate a token stream and collect the tokens by type.
See the βrulesβ module for definitions of keywords types and per-keyword rules.
The key types in this module are SectionRules, which explains how to validate and partition a stream of Item, and Section, which contains a validated set of Item, ready to be interpreted.
Β§Example
(This is an internal API, so see the routerdesc.rs source for an example of use.)
Re-exportsΒ§
use crate::parse::keyword::Keyword;πuse crate::NetdocErrorKind as EK;πuse crate::Result;πuse educe::Educe;πuse crate::parse::rules::*;πuse crate::parse::tokenize::*;π
StructsΒ§
- Section π
- A Section is the result of sorting a documentβs entries by keyword.
- Section
Rules π - Describe the rules for one section of a document.
- Section
Rules πBuilder - A builder for a set of section rules.
- TokVal π
- The entry or entries for a particular keyword within a document.