Struct StructureElement 

pub struct StructureElement {
    pub structure_type: StructureType,
    pub id: Option<String>,
    pub attributes: StructureAttributes,
    pub children: Vec<usize>,
    pub mcids: Vec<MarkedContentReference>,
}

A structure element in the document structure tree

Structure elements form a hierarchical tree that describes the logical organization of the document content.

Fields

structure_type: StructureType

The structure type (either standard or custom)

id: Option<String>

Element ID (optional, used for referencing)

attributes: StructureAttributes

Attributes for this element

children: Vec<usize>

Child elements (element IDs)

mcids: Vec<MarkedContentReference>

Marked content references (MCIDs) associated with this element

Implementations

impl StructureElement

pub fn new(structure_type: StandardStructureType) -> Self

Creates a new structure element with the given type

pub fn new_custom(type_name: impl Into<String>) -> Self

Creates a new structure element with a custom type

pub fn with_id(self, id: impl Into<String>) -> Self

Sets the element ID

pub fn with_language(self, lang: impl Into<String>) -> Self

Sets the language attribute

pub fn with_alt_text(self, alt: impl Into<String>) -> Self

Sets the alt text attribute

pub fn with_actual_text(self, text: impl Into<String>) -> Self

Sets the actual text attribute

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title attribute

pub fn add_mcid(&mut self, page_index: usize, mcid: u32)

Adds a marked content reference to this element

pub fn add_child(&mut self, child_index: usize)

Adds a child element (by index in the structure tree)

Trait Implementations

impl Clone for StructureElement

fn clone(&self) -> StructureElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructureElement

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

Formats the value using the given formatter.