Struct PdfStructTree 

pub struct PdfStructTree<'a> { /* private fields */ }

The structure tree of a PDF page, providing semantic document structure for tagged PDFs.

Elements in the tree have types like P (paragraph), H1-H6 (headings), Table, Figure, etc. The tree must be closed when it is no longer needed; this is handled automatically via the Drop implementation.

The tree handle is owned by this struct and will be released when it goes out of scope.

Implementations

impl<'a> PdfStructTree<'a>

pub fn children_count(&self) -> usize

Returns the number of top-level children in this structure tree.

pub fn child_at_index(&self, index: usize) -> Option<PdfStructElement<'_>>

Returns the top-level child element at the given index, or None on error or out-of-bounds index.

pub fn children(&self) -> PdfStructTreeChildrenIterator<'_>

Returns an iterator over the top-level children of this structure tree.

pub fn iter(&self) -> PdfStructTreeIterator<'_>

Returns a depth-first iterator over all elements in the structure tree.

Each item is a tuple of (element, depth) where depth starts at 0 for top-level (root) elements and increases by 1 for each level of nesting.

Trait Implementations

impl Drop for PdfStructTree<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.