Enum StructRole 

pub enum StructRole {
    Document,
    Heading(u8),
    Paragraph,
    Figure,
    Table,
    TableRow,
    TableHeaderCell,
    TableCell,
    List,
    ListItem,
    ListItemLabel,
    ListItemBody,
    Toc,
    TocItem,
    Artifact,
}

The PDF standard structure types (ISO 32000-1 14.8.4, Table 333/334) this crate tags content with — no RoleMap needed since all of these are standard types. Grouping roles (see StructRole::is_grouping) nest child StructElems and own no marked content of their own; Artifact is excluded from the structure tree entirely (watermarks, running headers/footers — PDF/UA pagination artifacts, not content).

Variants

Document

Heading(u8)

Text::outline_level 1-6, clamped (.outline_level(7+) still produces valid output, just tagged as the deepest standard heading level rather than inventing a 7th).

Paragraph

Figure

Table

TableRow

TableHeaderCell

TableCell

List

ListItem

ListItemLabel

ListItemBody

Toc

TocItem

Artifact

Not structure content at all — BDC/EMC with no MCID, entirely excluded from /StructTreeRoot (ISO 32000-1 14.8.2.2).

Implementations

impl StructRole

pub fn is_grouping(self) -> bool

true for roles that only nest child StructElems (no marked content of their own — see RenderNode::Tagged’s doc comment).

pub fn tag_name(self) -> &'static str

The PDF structure type name (ISO 32000-1 Table 333/334).

Trait Implementations

impl Clone for StructRole

fn clone(&self) -> StructRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StructRole

impl Debug for StructRole

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

Formats the value using the given formatter.

impl Eq for StructRole

impl PartialEq for StructRole

fn eq(&self, other: &StructRole) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StructRole