Struct Equation

pub struct Equation { /* private fields */ }

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.

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

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

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

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

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

Implementations

impl Equation

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

Create a new Equation.

pub fn with_label(label: &str, text: &str) -> Equation

Create an equation which has a label.

Examples found in repository

examples/complex.rs (line 36)

fn first_section() -> Section {
    let mut section_1 = Section::new("Introduction");
    section_1.push("This is an example paragraph.");

    let mut equations = Align::new();
    equations
        .push("y &= mx + c")
        .push(Equation::with_label("quadratic", "y &= a x^2 + bx + c"));

    section_1
        .push("Please refer to the equations below:")
        .push(equations);

    let mut objectives = List::new(ListKind::Enumerate);
    objectives
        .push(r"Demonstrate how to use the \textit{latex} library.")
        .push("Create a reasonably complex document")
        .push("???")
        .push("PROFIT!");

    section_1.push("Here are our objectives:").push(objectives);

    section_1
}

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

Give the equation a label.

pub fn text(&mut self, src: &str) -> &mut Self

Set the equation’s text.

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

Set whether the \nonumber command should be used to ignore numbering for this equation.

pub fn get_text(&self) -> &str

Get the equation’s text.

pub fn get_label(&self) -> Option<&str>

Get the equation label, if there is one.

pub fn is_numbered(&self) -> bool

Is this equation numbered?

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, f: &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<'a> From<&'a str> for Equation

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

Converts to this type from the input type.

impl PartialEq for Equation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Equation