Struct TocConfig 

pub struct TocConfig {
    pub title: Option<String>,
    pub levels: Option<Vec<u32>>,
    pub page_numbers: Option<bool>,
    pub leaders: Option<TocLeaders>,
}

Table of contents configuration.

Fields

title: Option<String>

Custom title for the table of contents.

levels: Option<Vec<u32>>

Which heading levels to include (e.g., [1, 2, 3]).

page_numbers: Option<bool>

Whether to show page numbers.

leaders: Option<TocLeaders>

Leader style between title and page number.

Implementations

impl TocConfig

pub fn new() -> Self

Create a new table of contents configuration.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the TOC title.

pub fn with_levels(self, levels: Vec<u32>) -> Self

Set which heading levels to include.

pub const fn with_page_numbers(self) -> Self

Enable page numbers.

pub const fn with_leaders(self, leaders: TocLeaders) -> Self

Set the leader style.

Trait Implementations

impl Clone for TocConfig

fn clone(&self) -> TocConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TocConfig

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

Formats the value using the given formatter.

impl Default for TocConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TocConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TocConfig

fn eq(&self, other: &TocConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TocConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TocConfig

impl StructuralPartialEq for TocConfig