Struct texcore::ty::Header

pub struct Header {
    pub name: String,
    pub header_level: u8,
    /* private fields */
}

Represents \section{} in latex

Fields

name: String

header_level: u8

Implementations

impl Header

pub fn new(name: &str, header_level: u8) -> Self

Examples found in repository

examples/doc_example.rs (line 12)

fn main() -> Result<(), Error> {
    let metadata = Metadata::new("Author", "date", "title", 11, "book", "article", 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:
    let input = Input::new(PathBuf::from("structure"), Level::Meta);
    list.write_split(
        PathBuf::from("main.tex"),
        PathBuf::from("structure.tex"),
        input,
    );
    // To print:
    list.print_tex();
    Ok(())
}

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

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

Deserialize this value from the given Serde deserializer.

impl ExtraOptions for Header

fn modify_element(&mut self, options: Vec<Options>)

impl From<Header> for Element<Any>

fn from(value: Header) -> Self

Converts to this type from the input type.

impl PartialEq<Header> for Header

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

fn partial_cmp(&self, other: &Header) -> 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 Serialize for Header

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

Serialize this value into the given Serde serializer.

impl Tex for Header

fn to_latex_string(&self) -> String

impl StructuralPartialEq for Header