Struct DocumentMetadata

Source

pub struct DocumentMetadata {
    pub title: Option<String>,
    pub author: Option<String>,
    pub subject: Option<String>,
    pub keywords: Option<String>,
    pub creator: Option<String>,
    pub producer: Option<String>,
    pub creation_date: Option<PdfDate>,
    pub mod_date: Option<PdfDate>,
    pub trapped: Option<TrappedFlag>,
    pub custom: HashMap<String, String>,
    pub xmp_xml: Option<String>,
}

Expand description

Information about a PDF document, drawn from the trailer’s /Info dict and the catalog’s /Metadata stream.

All fields are optional — a PDF may have no /Info dict, or a partial one. custom collects any non-standard /Info keys for callers that need to inspect them (e.g. preservation tools).

Fields§

§title: Option<String>

/Info /Title.

§author: Option<String>

/Info /Author.

§subject: Option<String>

/Info /Subject.

§keywords: Option<String>

/Info /Keywords.

§creator: Option<String>

/Info /Creator — the application that authored the source document.

§producer: Option<String>

/Info /Producer — the application that produced the PDF.

§creation_date: Option<PdfDate>

/Info /CreationDate, parsed from PDF date format.

§mod_date: Option<PdfDate>

/Info /ModDate, parsed from PDF date format.

§trapped: Option<TrappedFlag>

/Info /Trapped — whether the document has been pre-trapped for press.

§custom: HashMap<String, String>

Non-standard /Info entries, decoded as strings where possible.

§xmp_xml: Option<String>

Raw XMP metadata XML from the catalog’s /Metadata stream, if present.

Trait Implementations§

Source §

impl Clone for DocumentMetadata

Source §

fn clone(&self) -> DocumentMetadata

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for DocumentMetadata

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for DocumentMetadata

Source §

fn default() -> DocumentMetadata

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for DocumentMetadata

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §