Struct latex::Equation

pub struct Equation { /* fields omitted */ }

A single equation.

Examples

The Equation struct is designed to be added to an Align object. Creating one is as simple as using the constructor.

use latex::Equation;

let eq = Equation::new("y &= mx + c");

For convenience, you can also convert from a &str to an Equation using into().

use latex::Equation;

let eq: Equation = "y &= mx + c".into();

You can assign a label to an equation so it can be referenced later.

eq.label("basic-linear-equation");

Methods

impl Equation

fn new<S: AsRef<str>>(src: S) -> Equation

Create a new Equation.

fn label<S: AsRef<str>>(&mut self, text: S) -> &mut Self

Set the Equation's label.

fn not_numbered(&mut self) -> &mut Self

Don't number this equation.

Trait Implementations

impl Clone for Equation

fn clone(&self) -> Equation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Equation

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

Formats the value using the given formatter.

impl Default for Equation

fn default() -> Equation

Returns the "default value" for a type.

impl PartialEq for Equation

fn eq(&self, __arg_0: &Equation) -> bool

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

fn ne(&self, __arg_0: &Equation) -> bool

This method tests for !=.

impl Renderable for Equation

fn render<W>(&self, writer: &mut W) -> Result<()> where
    W: Write, 

Render the item.

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

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

Performs the conversion.