Struct Metadata 

pub struct Metadata { /* private fields */ }

PDF document metadata.

Contains standard PDF metadata fields. All fields are optional since PDFs may have incomplete or missing metadata.

Example

use pdfvec::{Extractor, Result};

fn main() -> Result<()> {
    let data = std::fs::read("document.pdf")?;
    let meta = Extractor::new().extract_metadata(&data)?;

    println!("Title: {:?}", meta.title());
    println!("Author: {:?}", meta.author());
    println!("Pages: {}", meta.page_count());
    Ok(())
}

Implementations

impl Metadata

pub fn title(&self) -> Option<&str>

Returns the document title, if present.

Example

let meta = Extractor::new().extract_metadata(&data)?;
if let Some(title) = meta.title() {
    println!("Document: {title}");
}

pub fn author(&self) -> Option<&str>

Returns the document author, if present.

pub fn subject(&self) -> Option<&str>

Returns the document subject, if present.

pub fn keywords(&self) -> Option<&str>

Returns the document keywords, if present.

Keywords are typically comma or space separated.

pub fn creator(&self) -> Option<&str>

Returns the application that created the original document.

pub fn producer(&self) -> Option<&str>

Returns the application that produced the PDF.

pub fn creation_date(&self) -> Option<DateTime<Utc>>

Returns the document creation date, if present and valid.

Example

let meta = Extractor::new().extract_metadata(&data)?;
if let Some(date) = meta.creation_date() {
    println!("Created: {}", date.format("%Y-%m-%d"));
}

pub fn modification_date(&self) -> Option<DateTime<Utc>>

Returns the document modification date, if present and valid.

pub fn page_count(&self) -> u32

Returns the number of pages in the document.

pub fn has_title(&self) -> bool

Returns true if the document has a title.

pub fn has_author(&self) -> bool

Returns true if the document has an author.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> 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 Eq for Metadata

impl StructuralPartialEq for Metadata