Struct Paragraph

pub struct Paragraph {
    pub elements: Vec<ParagraphElement>,
}

A single paragraph.

Examples

Like most of the other types in this crate, the standard workflow is to create an empty Paragraph then incrementally add bits to it using method chaining and the push() method.

use latex::{Paragraph, ParagraphElement};

let mut p = Paragraph::new();
p.push("Hello ")
 .push(ParagraphElement::italic("World"))
 .push("!")
 .push(" Here is an equation ")
 .push(ParagraphElement::InlineMath("y = mx + c".to_string()))
 .push(".");

The above paragraph would get rendered to something like this:

Hello \textit{World}! Here is an equation $y = mx + c$.

Fields

elements: Vec<ParagraphElement>

A list of ParagraphElements which make up the paragraph’s contents.

Implementations

impl Paragraph

pub fn new() -> Self

Create a new paragraph.

pub fn push<P>(&mut self, elem: P) -> &mut Self

where P: Into<ParagraphElement>,

Add a ParagraphElement to the Paragraph.

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

Add some raw text to the paragraph.

pub fn iter(&self) -> Iter<'_, ParagraphElement>

Iterate over the ParagraphElements in this Paragraph.

Trait Implementations

impl Clone for Paragraph

fn clone(&self) -> Paragraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Default for Paragraph

fn default() -> Paragraph

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<Paragraph> for Element

fn from(other: Paragraph) -> Self

Converts to this type from the input type.

impl PartialEq for Paragraph

fn eq(&self, other: &Paragraph) -> 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 Paragraph