Struct Description 

pub struct Description {

    pub name: String,
    pub kind: Kind,
    pub parameters: String,
    pub meaning: String,
    pub primitive: Option<&'static str>,
    pub defined: Option<Place>,
    pub earlier: Vec<Option<Place>>,
    pub redefinitions: usize,
    pub from_format: bool,
    pub aliases: Vec<String>,
    pub native: Option<&'static str>,
    pub similar: Vec<String>,
    pub inner: Option<Inner>,
}

A description of a control sequence.

Fields

name: String

The name, without the escape character.

kind: Kind

What it is.

parameters: String

For macros: the parameter text, as \show prints it.

meaning: String

The meaning, as \meaning gives it (for macros, the body after ->).

primitive: Option<&'static str>

For primitives: the primitive’s own name.

defined: Option<Place>

Where the current meaning was defined, if known.

earlier: Vec<Option<Place>>

Where earlier meanings were defined during the run, each place once, in order (None: unknown).

redefinitions: usize

The number of earlier definitions.

from_format: bool

Whether the meaning comes from the format (none of the run’s definitions made it).

aliases: Vec<String>

Other names with the same meaning.

native: Option<&'static str>

The name of retex’s native implementation, if it has one.

similar: Vec<String>

For undefined names: defined names close to it.

inner: Option<Inner>

The command a robust command or a document command stands for.

Trait Implementations

impl Clone for Description

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Description

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

Formats the value using the given formatter.