Struct Heading

pub struct Heading { /* private fields */ }

This structure models a heading which has a level and a string title. The level is unsigned but a value of 0 denotes a /pseudo-heading/ (see common::BlockFormat). Also the notion of a document title is separately specified at the page level (see common::PageFormat).

A heading may also include a label string that acts as an identifier, or anchor, for the heading.

Implementations

impl Heading

pub fn new<S>(level: u8, title: S) -> Self

where S: Into<String>,

pub fn with_label<S>(self, label: S) -> Self

where S: Into<String>,

pub fn new_section<S>(title: S) -> Self

where S: Into<String>,

pub fn new_subsection<S>(title: S) -> Self

where S: Into<String>,

pub fn new_subsubsection<S>(title: S) -> Self

where S: Into<String>,

pub const fn level(&self) -> u8

pub const fn is_section(&self) -> bool

pub const fn is_subsection(&self) -> bool

pub const fn is_subsubsection(&self) -> bool

pub fn title(&self) -> &str

pub const fn label(&self) -> Option<&String>

Trait Implementations

impl Clone for Heading

fn clone(&self) -> Heading

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Heading

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

Formats the value using the given formatter.