Struct OutlineEntry 

pub struct OutlineEntry {
    pub title: String,
    pub page: Option<String>,
    pub level: u8,
    pub entry_type: Option<String>,
    pub children: Vec<OutlineEntry>,
}

A hierarchical table of contents entry that can represent various Outline structures

This flexible model can handle:

• Simple flat TOCs: title + page
• Chapter-based TOCs: chapters with subsections
• Part-based TOCs: parts with chapters with sections
• Mixed hierarchies: any combination of the above

Fields

title: String

The title/heading text (required)

page: Option<String>

Page number or range (e.g., “15”, “15-20”, “iv”, “A-1”) Optional because some entries might be section dividers

level: u8

Hierarchical level (0 = top level, 1 = subsection, etc.) Helps maintain structure without complex nesting

entry_type: Option<String>

Optional type/category for semantic meaning Examples: “part”, “chapter”, “section”, “appendix”, “index”

children: Vec<OutlineEntry>

Child entries for hierarchical structures Empty for leaf entries

Implementations

impl OutlineEntry

pub fn new(title: String, page: Option<String>, level: u8) -> Self

pub fn with_type(self, entry_type: String) -> Self

pub fn with_children(self, children: Vec<OutlineEntry>) -> Self

pub fn add_child(&mut self, child: OutlineEntry)

Add a child entry

pub fn flatten(&self) -> Vec<FlatOutlineEntry>

Get all entries flattened with their hierarchical context

Trait Implementations

impl Clone for OutlineEntry

fn clone(&self) -> OutlineEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutlineEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutlineEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OutlineEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.