Enum CommandEvent 

pub enum CommandEvent<'src> {
    Command {
        name: &'src str,
        span: SourceSpan,
    },
    EnvironmentEnter {
        name: &'src str,
        span: SourceSpan,
    },
    EnvironmentExit {
        name: &'src str,
        span: SourceSpan,
    },
    TextModeEnter {
        span: SourceSpan,
    },
    TextModeExit {
        span: SourceSpan,
    },
}

One event from a left-to-right walk of math-body source.

Spans are byte ranges into the source slice passed to inspect_math_body. Command and environment names are returned without the leading backslash.

Variants

Command

A \name use that is not \begin, \end, or a recognised text-mode command. The span covers the backslash and the command name.

Fields

name: &'src str

Command name without the leading backslash.

span: SourceSpan

Byte range covering the command token in the source.

EnvironmentEnter

A \begin{name} opener. The span covers \begin and the brace group.

Fields

name: &'src str

Environment name as written inside the braces.

span: SourceSpan

Byte range from \begin through the closing brace.

EnvironmentExit

A matched \end{name} closer. The span covers \end and the brace group.

Fields

name: &'src str

Environment name as written inside the braces.

span: SourceSpan

Byte range from \end through the closing brace.

TextModeEnter

Entry into a text-mode region (\text{...} and friends). The span covers the opening brace only.

Fields

span: SourceSpan

Byte range of the opening brace.

TextModeExit

Exit from a text-mode region. The span covers the closing brace only.

Fields

span: SourceSpan

Byte range of the closing brace.

Trait Implementations

impl<'src> Clone for CommandEvent<'src>

fn clone(&self) -> CommandEvent<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for CommandEvent<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq for CommandEvent<'src>

fn eq(&self, other: &CommandEvent<'src>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'src> Copy for CommandEvent<'src>

impl<'src> Eq for CommandEvent<'src>

impl<'src> StructuralPartialEq for CommandEvent<'src>