Struct ParseLineOutput 

pub struct ParseLineOutput {
    pub ops: Vec<(usize, ScopeStackOp)>,
    pub replayed: Vec<Vec<(usize, ScopeStackOp)>>,
    pub warnings: Vec<String>,
}

Keeps the current parser state (the internal syntax interpreter stack) between lines of parsing.

If you are parsing an entire file you create one of these at the start and use it all the way to the end.

Caching

One reason this is exposed is that since it implements Clone you can actually cache these (probably along with a HighlightState) and only re-start parsing from the point of a change. See the docs for HighlightState for more in-depth discussion of caching.

This state doesn’t keep track of the current scope stack and parsing only returns changes to this stack so if you want to construct scope stacks you’ll need to keep track of that as well. Note that HighlightState contains exactly this as a public field that you can use.

Note: Caching is for advanced users who have tons of time to maximize performance or want to do so eventually. It is not recommended that you try caching the first time you implement highlighting.

Output of ParseState::parse_line.

ops contains the scope-stack operations for the current line, as before. replayed is non-empty only after a cross-line fail fires: it contains the corrected ops for each buffered line (in chronological order) so that callers who want full cross-line accuracy can re-apply them.

Callers that do not need cross-line accuracy can use .ops directly, which behaves identically to the old Vec<(usize, ScopeStackOp)> return.

Fields

ops: Vec<(usize, ScopeStackOp)>

Ops for the current line.

replayed: Vec<Vec<(usize, ScopeStackOp)>>

Ops for previously buffered lines that have now been corrected, in order. Non-empty only when a cross-line fail just resolved.

warnings: Vec<String>

Warnings collected during parsing (e.g. branch point expiry).

Trait Implementations

impl Clone for ParseLineOutput

fn clone(&self) -> ParseLineOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseLineOutput

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

Formats the value using the given formatter.

impl Default for ParseLineOutput

fn default() -> ParseLineOutput

Returns the “default value” for a type.