Enum latex::Element

pub enum Element {
    Para(Paragraph),
    Section(Section),
    TableOfContents,
    TitlePage,
    ClearPage,
    Align(Align),
    Environment(String, Vec<String>),
    UserDefined(String),
    List(List),
    Input(String),
    // some variants omitted
}

The major elements in a Document, representing each type of possible node.

For convenience, any variant which wraps a struct will implement From for that struct. Meaning you can create an Element::Para node just by using some_paragraph.into().

Variants

Para(Paragraph)

A bare paragraph.

Note

You probably don't want to add a paragraph directly to your document, instead add it to a Section so that if you are walking the AST later on things make sense.

Section(Section)

A section.

TableOfContents

The table of contents.

TitlePage

The title page.

ClearPage

Clear the page.

Align(Align)

An align environment for containing a bunch of equations.

Environment(String, Vec<String>)

A generic environment and its lines.

UserDefined(String)

Any other element.

This can be used as an escape hatch if the particular element you want isn't directly supported or if you need to do something which isn't easily expressed any other way. You simply provide the raw string you want and it will be rendered unchanged in the final document.

List(List)

A list.

Input(String)

A generic include statement

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<Element> for Document

fn extend<T: IntoIterator<Item = Element>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

impl From<Paragraph> for Element

fn from(other: Paragraph) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Element

fn from(other: &'a str) -> Self

Create an arbitrary unescaped element from a string.

impl From<List> for Element

fn from(other: List) -> Self

Performs the conversion.

impl From<Align> for Element

fn from(other: Align) -> Self

Performs the conversion.

impl From<Section> for Element

fn from(other: Section) -> Self

Performs the conversion.

impl<S, I> From<(S, I)> for Element where
    S: AsRef<str>,
    I: IntoIterator,
    I::Item: AsRef<str>, 

fn from(other: (S, I)) -> Self

Converts a tuple of name and a list of lines into an Element::Environment.

impl PartialEq<Element> for Element

fn eq(&self, other: &Element) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Element

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

Formats the value using the given formatter.