Struct Document

pub struct Document { /* private fields */ }

A PDF document that can contain multiple pages and metadata.

Example

use oxidize_pdf::{Document, Page};

let mut doc = Document::new();
doc.set_title("My Document");
doc.set_author("John Doe");

let page = Page::a4();
doc.add_page(page);

doc.save("output.pdf").unwrap();

Implementations

impl Document

pub fn new() -> Self

Creates a new empty PDF document.

pub fn add_page(&mut self, page: Page)

Adds a page to the document.

pub fn set_title(&mut self, title: impl Into<String>)

Sets the document title.

pub fn set_author(&mut self, author: impl Into<String>)

Sets the document author.

pub fn set_subject(&mut self, subject: impl Into<String>)

Sets the document subject.

pub fn set_keywords(&mut self, keywords: impl Into<String>)

Sets the document keywords.

pub fn set_creator(&mut self, creator: impl Into<String>)

Sets the document creator (software that created the original document).

pub fn set_producer(&mut self, producer: impl Into<String>)

Sets the document producer (software that produced the PDF).

pub fn set_creation_date(&mut self, date: DateTime<Utc>)

Sets the document creation date.

pub fn set_creation_date_local(&mut self, date: DateTime<Local>)

Sets the document creation date using local time.

pub fn set_modification_date(&mut self, date: DateTime<Utc>)

Sets the document modification date.

pub fn set_modification_date_local(&mut self, date: DateTime<Local>)

Sets the document modification date using local time.

pub fn update_modification_date(&mut self)

Sets the modification date to the current time.

pub fn page_count(&self) -> usize

Gets the number of pages in the document.

pub fn save(&mut self, path: impl AsRef<Path>) -> Result<()>

Saves the document to a file.

Errors

Returns an error if the file cannot be created or written.

pub fn write(&mut self, buffer: &mut Vec<u8>) -> Result<()>

Writes the document to a buffer.

Errors

Returns an error if the PDF cannot be generated.

Trait Implementations

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.