Struct latex::Document

pub struct Document {
    pub class: DocumentClass,
    pub preamble: Preamble,
    // some fields omitted
}

The root Document node.

Fields

class: DocumentClass

The document class.

preamble: Preamble

The Document's preamble.

Methods

impl Document

pub fn new(document_class: DocumentClass) -> Self

Create a new Document with the specified DocumentClass.

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

Add an element to the Document.

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

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

Iterate over the Elements in this document.

pub fn push_doc(&mut self, doc: &Document) -> &mut Self

A convience method to include one document into another by cloning the individual nodes.

Methods from Deref<Target = Vec<Element>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Default for Document

fn default() -> Document

Returns the "default value" for a type.

impl Clone for Document

fn clone(&self) -> Document

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 PartialEq<Document> for Document

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

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

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

This method tests for !=.

impl Deref for Document

type Target = Vec<Element>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

A shortcut to let you iterate over the elements in the Document.

impl Debug for Document

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

Formats the value using the given formatter.