Enum StructRole2 

pub enum StructRole2 {
    Document,
    DocumentFragment,
    Part,
    Sect,
    Div,
    Aside,
    NonStruct,
    P,
    Heading(NonZeroU16),
    StructuredHeading,
    Title,
    FENote,
    Sub,
    Lbl,
    Span,
    Em,
    Strong,
    Link,
    Annot,
    Form,
    Ruby,
    RB,
    RT,
    RP,
    Warichu,
    WT,
    WP,
    L,
    LI,
    LBody,
    Table,
    TR,
    TH,
    TD,
    THead,
    TBody,
    TFoot,
    Caption,
    Figure,
    Formula,
    Artifact,
}

PDF 2.0 roles the structure element fulfills in the document.

These are the predefined standard roles in PDF 2.0, matching the https://www.iso.org/pdf2/ssn namespace. The writer may write their own types and then provide a mapping using Namespace::role_map_ns. PDF 2.0+.

Variants

Document

The whole document.

DocumentFragment

An incomplete fragment of another document.

Part

A part of a document that may contain multiple articles or sections.

Sect

Section of a larger document.

Div

Generic subdivision.

Aside

Content distinct from other content within the parent, such as callouts, sidebars, commentary, or background information.

NonStruct

Element only present for grouping purposes that shall not be exported.

P

A paragraph

Heading(NonZeroU16)

Heading with a specific level.

StructuredHeading

Strongly structured heading.

Title

A title of a document.

FENote

A foot- or endnote.

Sub

A subdivision within a block level element.

Lbl

Label for a list item.

Span

A generic inline element.

Em

An emphasized inline element.

Strong

An inline element with heightened (strong) importance.

Link

A link.

Annot

An association between an annotation and the content it belongs to.

Form

Form widget.

Ruby

Ruby annotation for CJK text.

RB

Base text of a Ruby annotation.

RT

Annotation text of a Ruby annotation.

RP

Punctuation in a Ruby annotation.

Warichu

Warichu annotation for CJK text.

WT

Text of a Warichu annotation.

WP

Punctuation of a Warichu annotation.

L

A list.

LI

A list item.

LBody

Description of the list item.

Table

A table.

TR

A table row.

TH

A table header cell.

TD

A table data cell.

THead

A table header row group.

TBody

A table data row group.

TFoot

A table footer row group.

Caption

An image or figure caption.

Figure

Item of graphical content.

Formula

Mathematical formula.

Artifact

An artifact not part of the logical content of the document.

Implementations

impl StructRole2

pub fn to_name(self, buf: &mut [u8; 6]) -> Name<'_>

Convert the role into its Name serialization.

The buf parameter is a mutable buffer of 6 bytes that will be used to store the name in the event that the role is a heading with a level.

pub fn compatibility_1_7(self, opts: RoleMapOpts) -> StructRole2Compat

How the type should be represented in PDF 1.7.

The opts parameter allows to control how certain roles are represented in PDF 1.7. You can also use its default constructor.

pub fn role_type(self) -> StructRoleType2

Return the type of the structure element.

Trait Implementations

impl Clone for StructRole2

fn clone(&self) -> StructRole2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructRole2

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

Formats the value using the given formatter.

impl Hash for StructRole2

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StructRole2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<StructRole> for StructRole2

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: StructRole) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<StructRole2> for StructRole

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: StructRole2) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for StructRole2

impl Eq for StructRole2

impl StructuralPartialEq for StructRole2