Struct DocumentMetadata 

pub struct DocumentMetadata {
    pub title: Option<String>,
    pub author: Option<String>,
    pub subject: Option<String>,
    pub keywords: Option<String>,
    pub creator: Option<String>,
    pub version: Option<String>,
    pub tagged: bool,
    pub language: Option<String>,
    pub role_map: Vec<(String, String)>,
}

Metadata for a PDF document.

Fields

title: Option<String>

Document title

author: Option<String>

Document author

subject: Option<String>

Document subject

keywords: Option<String>

Document keywords

creator: Option<String>

Creator application

version: Option<String>

PDF version (default: “1.7”)

tagged: bool

When true, emit PDF/UA-1 tagged-PDF catalog entries (/MarkInfo, /StructTreeRoot, /Lang, /ViewerPreferences). F-1/F-2.

language: Option<String>

Document natural language tag (e.g. “en-US”). Emitted as catalog /Lang when tagged is true, but also usable without tagging. F-2.

role_map: Vec<(String, String)>

Custom-type → standard-type role mappings for /RoleMap. F-4.

Implementations

impl DocumentMetadata

pub fn new() -> Self

Create new empty metadata.

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

Set document title.

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

Set document author.

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

Set document subject.

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

Set document keywords.

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

Set creator application.

pub fn tagged_pdf_ua1(self) -> Self

Enable PDF/UA-1 tagging. When true, DocumentBuilder::build will emit /MarkInfo, /StructTreeRoot, /Lang, and /ViewerPreferences in the catalog. Has no effect on existing callers that do not call this method.

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

Set the document’s natural language (e.g. "en-US"). Emitted as /Lang in the PDF catalog when tagged_pdf_ua1() is set.

pub fn role_map( self, custom: impl Into<String>, standard: impl Into<String>, ) -> Self

Add a custom → standard role mapping to the StructTreeRoot /RoleMap. Multiple calls accumulate entries. Example: ("Note", "P") maps the custom “Note” structure type to the standard “P” (Paragraph).

Trait Implementations

impl Clone for DocumentMetadata

fn clone(&self) -> DocumentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMetadata

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

Formats the value using the given formatter.

impl Default for DocumentMetadata

fn default() -> DocumentMetadata

Returns the “default value” for a type.