Struct texcore::element::ElementList

pub struct ElementList<T: Tex> { /* private fields */ }

A linked list of elements

Implementations

impl ElementList<Any>

pub fn new(metadata: &Metadata) -> Self

Creates a new empty list

Examples found in repository

examples/doc_example.rs (line 9)

fn main() -> Result<(), Error> {
    let metadata = Metadata::new("Author", "date", "title", 11, "book", true);
    let mut list = ElementList::new(&metadata);
    let part = Part::new("part");
    let chapter = Chapter::new("chapter");
    let header1 = Header::new("header1", 1);
    let header2 = Header::new("header2", 2);
    let text = Text::new("text", TextType::Normal);
    let pkg = Package::new("dramatist");
    list.push_array(Elements![part, chapter, header1, header2, text, pkg]);
    /*
        To compile, use the `compile` feature
        list.compile(PathBuf::from("test.pdf");
        To write to single tex file:
        list.write(PathBuf::from("test.tex"))?;
        To split write Packages and Main file:
        list.write_split(PathBuf::from("main.tex"), PathBuf::from("structure.tex"))?;
        To print:
        list.print_tex();
    */
    Ok(())
}

pub fn add_newpage(&mut self)

Adds in \newpage text as next element in the list

pub fn push(&mut self, element: Element<Any>)

Pushes an element to the end of the list

pub fn push_array(&mut self, element_vec: Vec<Element<Any>>)

Pushes an element vector into the list

Examples found in repository

examples/doc_example.rs (line 16)

fn main() -> Result<(), Error> {
    let metadata = Metadata::new("Author", "date", "title", 11, "book", true);
    let mut list = ElementList::new(&metadata);
    let part = Part::new("part");
    let chapter = Chapter::new("chapter");
    let header1 = Header::new("header1", 1);
    let header2 = Header::new("header2", 2);
    let text = Text::new("text", TextType::Normal);
    let pkg = Package::new("dramatist");
    list.push_array(Elements![part, chapter, header1, header2, text, pkg]);
    /*
        To compile, use the `compile` feature
        list.compile(PathBuf::from("test.pdf");
        To write to single tex file:
        list.write(PathBuf::from("test.tex"))?;
        To split write Packages and Main file:
        list.write_split(PathBuf::from("main.tex"), PathBuf::from("structure.tex"))?;
        To print:
        list.print_tex();
    */
    Ok(())
}

pub fn pop(&mut self) -> Option<Element<Any>>

Pops an element at the end of the list

pub fn fpush(&mut self, element: Element<Any>)

Pushes element to the front of the list

pub fn fpop(&mut self) -> Option<Element<Any>>

Pops an element in the front of the list

pub fn to_latex_string(&mut self) -> String

Walks the list and returns a combined latex string

pub fn to_latex_split_string(&mut self) -> (String, String)

Walks the list and returns a split latex string separating Packages level

pub fn write(&mut self, main: PathBuf) -> Result<(), Error>

Writes ElementList into a latex file

pub fn write_split(
    &mut self,
    main: PathBuf,
    structure: PathBuf
) -> Result<(), Error>

Writes ElementList into two latex files splitting the main content and structure path for packages

pub fn print_tex(&mut self)

Prints the whole tex source code

pub fn list_to_array(&self) -> Vec<Element<Any>>

Returns &self.list to Vec<Element<Any>>

pub fn metadata(&self) -> Metadata

returns the list’s metadata

Trait Implementations

impl<T: Clone + Tex> Clone for ElementList<T>

fn clone(&self) -> ElementList<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Tex> Debug for ElementList<T>

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

Formats the value using the given formatter.

impl Default for ElementList<Any>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for ElementList<T>where
    T: Deserialize<'de> + Tex,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Tex> PartialEq<ElementList<T>> for ElementList<T>

fn eq(&self, other: &ElementList<T>) -> bool

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

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

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

impl<T: PartialOrd + Tex> PartialOrd<ElementList<T>> for ElementList<T>

fn partial_cmp(&self, other: &ElementList<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for ElementList<T>where
    T: Serialize + Tex,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Tex> StructuralPartialEq for ElementList<T>