Enum TransitionResult 

pub enum TransitionResult {
    Success {
        doctree: DocTree,
        push_or_pop: PushOrPop,
        line_advance: LineAdvance,
    },
    Failure {
        message: String,
        doctree: DocTree,
    },
}

An enumeration of the different results, including errors, that a transition function might have.

Variants

Success

This is returned if nothing goes wrong with a transition method. It includes the modified document tree, plus information about how to manipulate the parser stack, whether the parser should advance its line cursor.

Fields

doctree: DocTree

push_or_pop: PushOrPop

line_advance: LineAdvance

Failure

A general failure result. This will be returned if a clear error, such as a completetely invalid enumerator was encountered in a transition method functions. Contains an error message and the doctree in its current state.

Fields

message: String

doctree: DocTree