Struct latex::List

pub struct List {
    pub kind: ListKind,
    // some fields omitted
}

A list (either dot points or numbered).

Examples

A list can be used like so:

use latex::{List, ListKind};

let mut list = List::new(ListKind::Itemize);
list.push("Hello").push("From").push("Some").push("Dot-points");

Calling the render() method on the list will then give something like this:

\begin{itemize}
\item Hello
\item From
\item Some
\item Dot-points
\end{itemize}

Fields

kind: ListKind

The kind of list this is.

Methods

impl List

pub fn new(kind: ListKind) -> List

Create an empty list of the specified type.

pub fn push<S: AsRef<str>>(&mut self, item: S) -> &mut Self

Add an element to the list.

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

Iterate over the items in the list.

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<List> for Element

fn from(other: List) -> Self

Performs the conversion.

impl PartialEq<List> for List

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

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

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

This method tests for !=.

impl Debug for List

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

Formats the value using the given formatter.