Struct StructTreeRoot 

pub struct StructTreeRoot {
    pub root_elements: Vec<StructElem>,
    pub parent_tree: Option<ParentTree>,
    pub role_map: HashMap<String, String>,
}

The root of a PDF structure tree (StructTreeRoot dictionary).

This is the entry point for accessing a document’s logical structure. According to PDF spec Section 14.7.2, the StructTreeRoot contains:

• /Type - Must be /StructTreeRoot
• /K - The immediate child or children of the structure tree root
• /ParentTree - Maps marked content to structure elements
• /RoleMap - Maps non-standard structure types to standard ones

Fields

root_elements: Vec<StructElem>

Root structure element(s)

parent_tree: Option<ParentTree>

Parent tree mapping MCIDs to structure elements (optional)

role_map: HashMap<String, String>

Role map for custom structure types (optional)

Implementations

impl StructTreeRoot

pub fn new() -> Self

Create a new structure tree root

pub fn add_root_element(&mut self, elem: StructElem)

Add a root element to the structure tree

Trait Implementations

impl Clone for StructTreeRoot

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructTreeRoot

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

Formats the value using the given formatter.

impl Default for StructTreeRoot

fn default() -> Self

Returns the “default value” for a type.