Struct TableOfContents 

pub struct TableOfContents {
    pub max_depth: u8,
    pub style: TextStyle,
    pub leader: char,
    pub skip: usize,
    pub common: Common,
}

Self-populating from every Text::outline_level/.heading1()-etc. heading in the document (the same source the PDF bookmark sidebar is built from), with correct page numbers — the two-pass layout already determines those in pass 1, this element just renders them in pass 2 (see lightweight-pdf-layout::toc). Entries are always left-aligned, one per line, indented by heading depth, with a leader (.leader()) filling the gap to a right-hand page number; .style controls font/size/color for every entry uniformly.

Fields

max_depth: u8

Only headings at this outline_level or shallower become entries (default 3).

style: TextStyle

leader: char

Character repeated between an entry’s title and its page number (default .); set to ' ' for no visible leader.

skip: usize

Internal: how many matching headings to skip before this instance’s first entry. Set only by the layout crate when a TableOfContents itself splits across a page boundary — always 0 on one an author constructs.

common: Common

Implementations

impl TableOfContents

pub fn new() -> Self

pub fn max_depth(self, depth: u8) -> Self

pub fn leader(self, leader: char) -> Self

pub fn style(self, style: TextStyle) -> Self

pub fn width(self, width: f32) -> Self

pub fn height(self, height: f32) -> Self

pub fn flex(self, factor: f32) -> Self

pub fn padding(self, padding: f32) -> Self

pub fn corner_radius(self, radius: f32) -> Self

pub fn overflow(self, overflow: Overflow) -> Self

pub fn background(self, color: Color) -> Self

pub fn border(self, border: Border) -> Self

pub fn keep_with_next(self) -> Self

See plan/05-overflow-and-robustness.md Grundprinzip 9: only placed on a page if the following sibling also still fits.

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() -> Self

Returns the “default value” for a type.

impl From<TableOfContents> for Element

fn from(value: TableOfContents) -> Self

Converts to this type from the input type.