Struct latex::Align

pub struct Align { /* fields omitted */ }

A list of equations to be used in an align environment.

Note

Using this environment requires you to include the amsmath package in your preamble.

Examples

The typical workflow is to create an empty Align and then add equations to it.

use latex::{Align, Equation};
let mut equations = Align::new();
equations.push("y &= mx + c")
         .push(Equation::with_label("emc2", "E &= m c^2"));

When rendered, you should get something like this:

\begin{align}
y &= mx + c \\
E &= m c^2 \\
\end{align}

Methods

impl Align

pub fn new() -> Align

Create an empty equation list.

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

Iterate over each of this equations in the list.

pub fn push<E: Into<Equation>>(&mut self, eq: E) -> &mut Self

Add an equation to the end of the list.

Trait Implementations

impl Default for Align

fn default() -> Align

Returns the "default value" for a type.

impl Clone for Align

fn clone(&self) -> Align

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Align> for Element

fn from(other: Align) -> Self

Performs the conversion.

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

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

Convert a string into a single equation wrapped in an align.

impl PartialEq<Align> for Align

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

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

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

This method tests for !=.

impl Debug for Align

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

Formats the value using the given formatter.