Struct latex::Preamble

pub struct Preamble {
    pub author: Option<String>,
    pub title: Option<String>,
    // some fields omitted
}

A node representing the document's preamble.

Fields

author: Option<String>

The document's author.

title: Option<String>

An optional title for the document.

Methods

impl Preamble

pub fn author(&mut self, name: &str) -> &mut Self

Set the document's author.

pub fn title(&mut self, name: &str) -> &mut Self

Set the document title.

pub fn use_package(&mut self, name: &str) -> &mut Self

Add a package import to the preamble.

pub fn iter(&self) -> Iter<PreambleElement>

Iterate over each package used in the Preamble.

pub fn is_empty(&self) -> bool

Is the preamble empty?

pub fn push<E>(&mut self, element: E) -> &mut Self where
    E: Into<PreambleElement>, 

Add a PreambleElement to the Preamble.

To make this work as seamlessly as possible, it will accept anything which can be converted into an PreambleElement using into() and supports the builder pattern with method chaining.

Trait Implementations

impl Default for Preamble

fn default() -> Preamble

Returns the "default value" for a type.

impl Clone for Preamble

fn clone(&self) -> Preamble

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<PreambleElement> for Preamble

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

Extends a collection with the contents of an iterator.

impl PartialEq<Preamble> for Preamble

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

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

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

This method tests for !=.

impl Debug for Preamble

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

Formats the value using the given formatter.