Enum Grouping

pub enum Grouping {
    Normal,
    LeftRight(Option<char>, Option<char>),
    Array(Box<[ArrayColumn]>),
    Matrix {
        alignment: ColumnAlignment,
    },
    Cases {
        left: bool,
    },
    Equation {
        eq_numbers: bool,
    },
    Align {
        eq_numbers: bool,
    },
    Aligned,
    SubArray {
        alignment: ColumnAlignment,
    },
    Alignat {
        pairs: u16,
        eq_numbers: bool,
    },
    Alignedat {
        pairs: u16,
    },
    Gather {
        eq_numbers: bool,
    },
    Gathered,
    Multline,
    Split,
}

Represents a grouping of elements, which is itself a single logical element.

This can be created by a lot of different LaTeX commands, such as {}, \left, \right, \begin{...}, \end{...}, etc.

Variants

Normal

A normal form of grouping, usually induced by {} or \begingroup and \endgroup in LaTeX.

LeftRight(Option<char>, Option<char>)

A grouping that is induced by \left and \right in LaTeX.

Array(Box<[ArrayColumn]>)

The array environment of LaTeX.

It’s content is an array of columns, which represents the column specification in LaTeX.

Example

Input: \begin{array}{lcr} ... \end{array} Generates:

Grouping::Array(Box::new([
    ArrayColumn::Column(ColumnAlignment::Left),
    ArrayColumn::Column(ColumnAlignment::Center),
    ArrayColumn::Column(ColumnAlignment::Right),
]));

Invariant

The content of the Array variant is guaranteed to be non-empty, and contain at least one ArrayColumn::Column.

Matrix

The matrix environment of LaTeX.

Fields

alignment: ColumnAlignment

The default alignment is ColumnAlignment::Center, but it can be specified by in LaTeX when using the \begin{matrix*}[l] ... \end{matrix*} syntax.

Cases

The cases environment of LaTeX.

Fields

left: bool

left is true if the environment is cases and false if the environment is rcases.

Equation

The equation environment of LaTeX.

Fields

eq_numbers: bool

If eq_numbers is true, then equation numbers are displayed.

Align

The align environment of LaTeX.

Fields

eq_numbers: bool

If eq_numbers is true, then equation numbers are displayed.

Aligned

The aligned environment of LaTeX.

SubArray

The subarray environment of LaTeX.

Fields

alignment: ColumnAlignment

The alignment of the columns in the subarray.

Alignat

The alignat environment of LaTeX.

Fields

pairs: u16

pairs specifies the number of left-right column pairs specified in the environment declaration.

eq_numbers: bool

If eq_numbers is true, then equation numbers are displayed.

Alignedat

The alignedat environment of LaTeX.

Fields

pairs: u16

pairs specifies the number of left-right column pairs specified in the environment

Gather

The gather environment of LaTeX.

Fields

eq_numbers: bool

If eq_numbers is true, then equation numbers are displayed.

Gathered

The gathered environment of LaTeX.

Multline

The multline environment of LaTeX.

Split

The split environment of LaTeX.

Trait Implementations

impl Clone for Grouping

fn clone(&self) -> Grouping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Grouping

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

Formats the value using the given formatter.

impl PartialEq for Grouping

fn eq(&self, other: &Grouping) -> 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 StructuralPartialEq for Grouping