Struct ListingOutline 

pub struct ListingOutline {
    pub document_title: Option<String>,
    pub entries: Vec<OutlineEntry>,
    pub confidence: f64,
    pub metadata: OutlineMetadata,
}

Complete table of contents structure

Fields

document_title: Option<String>

Document title (optional)

entries: Vec<OutlineEntry>

Main Outline entries

confidence: f64

Extraction confidence (0.0 - 1.0)

metadata: OutlineMetadata

Additional metadata about the Outline structure

Implementations

impl ListingOutline

pub fn new() -> Self

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

Get all entries as a flat list

pub fn entries_at_level(&self, level: u8) -> Vec<&OutlineEntry>

Get entries at a specific level

pub fn max_depth(&self) -> u8

Get the maximum depth of the Outline

Trait Implementations

impl Clone for ListingOutline

fn clone(&self) -> ListingOutline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListingOutline

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

Formats the value using the given formatter.

impl Default for ListingOutline

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListingOutline

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListingOutline

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

where __S: Serializer,

Serialize this value into the given Serde serializer.