Struct TableOfContents 

pub struct TableOfContents {
    pub entries: Vec<TocEntry>,
}

A complete table of contents.

Fields

entries: Vec<TocEntry>

Top-level entries.

Implementations

impl TableOfContents

pub fn from_pages(pages: &[Vec<ContentElement>]) -> Self

Build a TOC from document pages by extracting headings.

pub fn total_entries(&self) -> usize

Total number of entries (including nested).

pub fn to_markdown(&self) -> String

Render the TOC as a markdown string.

pub fn to_html(&self) -> String

Render the TOC as an HTML unordered list.

pub fn is_empty(&self) -> bool

Whether the TOC is empty.

Trait Implementations

impl Clone for TableOfContents

fn clone(&self) -> TableOfContents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableOfContents

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

Formats the value using the given formatter.

impl Default for TableOfContents

fn default() -> TableOfContents

Returns the “default value” for a type.