Struct DocumentStructure 

pub struct DocumentStructure {
    pub headings: Vec<Heading>,
    pub sections: Vec<Section>,
    pub hierarchy: HeadingHierarchy,
}

Complete document structure with headings and sections

Fields

headings: Vec<Heading>

All headings found in the document, in order of appearance

sections: Vec<Section>

All sections derived from headings

hierarchy: HeadingHierarchy

Hierarchical relationships between sections

Implementations

impl DocumentStructure

pub fn new() -> Self

Create a new empty document structure

pub fn find_section_containing_offset(&self, offset: usize) -> Option<usize>

Find the section index that contains the given offset

pub fn get_heading_path(&self, section_idx: usize) -> Vec<String>

Get the heading path from root to the given section

Returns a vector of heading texts in hierarchical order Example: [“Chapter 1”, “Section 1.1”, “Subsection 1.1.1”]

pub fn get_sections_at_level(&self, level: u8) -> Vec<&Section>

Get all sections at a specific hierarchical level

pub fn section_count(&self) -> usize

Get the total number of sections

pub fn max_depth(&self) -> usize

Get the maximum depth of the hierarchy

pub fn has_structure(&self) -> bool

Check if the document has any structure

pub fn get_statistics(&self) -> StructureStatistics

Get statistics about the document structure

Trait Implementations

impl Clone for DocumentStructure

fn clone(&self) -> DocumentStructure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentStructure

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

Formats the value using the given formatter.

impl Default for DocumentStructure

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentStructure

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentStructure

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

where __S: Serializer,

Serialize this value into the given Serde serializer.