Document

Struct Document 

Source
pub struct Document { /* private fields */ }
Expand description

The base of the generated LaTeX file. Containers and Items can be added to the Document object. Packages and global Commands are located before the \begin{document} line. Other Items are located between the \begin{document} and \end{document} lines.

Implementations§

Source§

impl Document

Source

pub fn new(doc_file: File, doc_class: DocumentClass) -> Self

Initializes a new Document object. A File and a DocumentClass need to be passed for the creation of the Document.

Source

pub fn add_item<I: Item + 'static>(&mut self, item: I)

Adds an Item to the Document.

Source

pub fn add_packages(&mut self, _packages: Vec<Package>)

Adds a list of Packages to the Document.

Source

pub fn add_global_commands(&mut self, _commands: Vec<Command>)

Adds a list of global Commands to the Document. These commands are located before the \begin{document} line.

Source

pub fn build(&mut self)

Builds and generates the LaTeX file.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.