Struct AreaTree 

pub struct AreaTree {
    pub document_lang: Option<String>,
    /* private fields */
}

Area tree - arena-allocated tree of areas

Fields

document_lang: Option<String>

Document language from xml:lang on fo:root (for PDF /Lang entry)

Implementations

impl AreaTree

pub fn new() -> Self

Create a new empty area tree

pub fn with_capacity(capacity: usize) -> Self

Create an area tree with preallocated capacity

pub fn add_area(&mut self, area: Area) -> AreaId

Add an area to the tree

pub fn get(&self, id: AreaId) -> Option<&AreaNode>

Get a reference to an area by ID

pub fn get_mut(&mut self, id: AreaId) -> Option<&mut AreaNode>

Get a mutable reference to an area by ID

pub fn len(&self) -> usize

Get the number of areas in the tree

pub fn is_empty(&self) -> bool

Check if the tree is empty

pub fn append_child( &mut self, parent: AreaId, child: AreaId, ) -> Result<(), String>

Append a child area to a parent

pub fn children(&self, parent: AreaId) -> Vec<AreaId>

Get all children of an area

pub fn iter(&self) -> impl Iterator<Item = (AreaId, &AreaNode)>

Iterate over all areas

pub fn root(&self) -> Option<(AreaId, &AreaNode)>

Get the root area (first area in tree)

pub fn add_footnote(&mut self, page_id: AreaId, footnote_id: AreaId)

Add a footnote to a page

pub fn get_footnotes(&self, page_id: AreaId) -> Option<&Vec<AreaId>>

Get footnotes for a page

pub fn find_page_ancestor(&self, area_id: AreaId) -> Option<AreaId>

Find the nearest Page ancestor for a given area (or the area itself if it’s a Page)

pub fn serialize(&self) -> String

Serialize the area tree as an indented text tree for debugging

pub fn footnote_height(&self, page_id: AreaId) -> Length

Calculate total height of footnotes for a page

pub fn diff(&self, other: &AreaTree) -> Vec<String>

Compute structural differences between two area trees.

Returns a list of difference descriptions. An empty list means the trees are structurally identical.

Trait Implementations

impl Default for AreaTree

fn default() -> Self

Returns the “default value” for a type.