Struct StructTree 

pub struct StructTree {
    pub role_map: RoleMap,
    /* private fields */
}

Structure tree - hierarchical organization of document structure

The structure tree describes the logical organization of content in a tagged PDF document.

Fields

role_map: RoleMap

Role map for custom structure types

Implementations

impl StructTree

pub fn new() -> Self

Creates a new empty structure tree

pub fn set_root(&mut self, element: StructureElement) -> usize

Adds a root element to the tree (typically Document)

pub fn add_child( &mut self, parent_index: usize, element: StructureElement, ) -> Result<usize, String>

Adds an element as a child of another element

pub fn get(&self, index: usize) -> Option<&StructureElement>

Gets an element by index

pub fn get_mut(&mut self, index: usize) -> Option<&mut StructureElement>

Gets a mutable reference to an element by index

pub fn get_by_id(&self, id: &str) -> Option<&StructureElement>

Gets an element by ID

pub fn root_index(&self) -> Option<usize>

Gets the root element index

pub fn root(&self) -> Option<&StructureElement>

Gets the root element

pub fn len(&self) -> usize

Returns the total number of elements in the tree

pub fn is_empty(&self) -> bool

Returns true if the tree is empty

pub fn iter(&self) -> impl Iterator<Item = &StructureElement>

Returns an iterator over all elements

Trait Implementations

impl Clone for StructTree

fn clone(&self) -> StructTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructTree

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

Formats the value using the given formatter.

impl Default for StructTree

fn default() -> Self

Returns the “default value” for a type.