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_form_manager(&mut self, form_manager: FormManager)

Sets the form manager for the document.

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_encryption(&mut self, encryption: DocumentEncryption)

Set document encryption

pub fn encrypt_with_passwords( &mut self, user_password: impl Into<String>, owner_password: impl Into<String>, )

Set simple encryption with passwords

pub fn is_encrypted(&self) -> bool

Check if document is encrypted

pub fn set_open_action(&mut self, action: Action)

Set the action to execute when the document is opened

pub fn open_action(&self) -> Option<&Action>

Get the document open action

pub fn set_viewer_preferences(&mut self, preferences: ViewerPreferences)

Set viewer preferences for controlling document display

pub fn viewer_preferences(&self) -> Option<&ViewerPreferences>

Get viewer preferences

pub fn set_outline(&mut self, outline: OutlineTree)

Set document outline (bookmarks)

pub fn outline(&self) -> Option<&OutlineTree>

Get document outline

pub fn outline_mut(&mut self) -> Option<&mut OutlineTree>

Get mutable document outline

pub fn set_named_destinations(&mut self, destinations: NamedDestinations)

Set named destinations

pub fn named_destinations(&self) -> Option<&NamedDestinations>

Get named destinations

pub fn named_destinations_mut(&mut self) -> Option<&mut NamedDestinations>

Get mutable named destinations

pub fn set_page_labels(&mut self, labels: PageLabelTree)

Set page labels

pub fn page_labels(&self) -> Option<&PageLabelTree>

Get page labels

pub fn page_labels_mut(&mut self) -> Option<&mut PageLabelTree>

Get mutable page labels

pub fn get_page_label(&self, page_index: u32) -> String

Get page label for a specific page

pub fn get_all_page_labels(&self) -> Vec<String>

Get all page labels

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 set_default_font_encoding(&mut self, encoding: Option<FontEncoding>)

Sets the default font encoding for fonts that don’t specify an encoding.

This encoding will be applied to fonts in the PDF font dictionary when no explicit encoding is specified. Setting this to None (the default) means no encoding metadata will be added to fonts unless explicitly specified.

Example

use oxidize_pdf::{Document, text::FontEncoding};

let mut doc = Document::new();
doc.set_default_font_encoding(Some(FontEncoding::WinAnsiEncoding));

pub fn default_font_encoding(&self) -> Option<FontEncoding>

Gets the current default font encoding.

pub fn add_font( &mut self, name: impl Into<String>, path: impl AsRef<Path>, ) -> Result<()>

Add a custom font from a file path

Example

use oxidize_pdf::Document;

let mut doc = Document::new();
doc.add_font("MyFont", "path/to/font.ttf").unwrap();

pub fn add_font_from_bytes( &mut self, name: impl Into<String>, data: Vec<u8>, ) -> Result<()>

Add a custom font from byte data

Example

use oxidize_pdf::Document;

let mut doc = Document::new();
let font_data = vec![0; 1000]; // Your font data
doc.add_font_from_bytes("MyFont", font_data).unwrap();

pub fn has_custom_font(&self, name: &str) -> bool

Check if a custom font is loaded

pub fn custom_font_names(&self) -> Vec<String>

Get all loaded custom font names

pub fn page_count(&self) -> usize

Gets the number of pages in the document.

pub fn acro_form(&self) -> Option<&AcroForm>

Gets a reference to the AcroForm (interactive form) if present.

pub fn acro_form_mut(&mut self) -> Option<&mut AcroForm>

Gets a mutable reference to the AcroForm (interactive form) if present.

pub fn enable_forms(&mut self) -> &mut FormManager

Enables interactive forms by creating a FormManager if not already present. The FormManager handles both the AcroForm and the connection with page widgets.

pub fn disable_forms(&mut self)

Disables interactive forms by removing both the AcroForm and FormManager.

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 save_with_config( &mut self, path: impl AsRef<Path>, config: WriterConfig, ) -> Result<()>

Saves the document to a file with custom writer configuration.

Errors

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

pub fn save_with_custom_values( &mut self, path: impl AsRef<Path>, custom_values: &HashMap<String, String>, ) -> Result<()>

Saves the document to a file with custom values for headers/footers.

This method processes all pages to replace custom placeholders in headers and footers before saving the document.

Arguments

• path - The path where the document should be saved
• custom_values - A map of placeholder names to their replacement values

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.

pub fn set_compress(&mut self, compress: bool)

Enables or disables compression for PDF streams.

When compression is enabled (default), content streams and XRef streams are compressed using Flate/Zlib compression to reduce file size. When disabled, streams are written uncompressed, making the PDF larger but easier to debug.

Arguments

• compress - Whether to enable compression

Example

use oxidize_pdf::{Document, Page};

let mut doc = Document::new();

// Disable compression for debugging
doc.set_compress(false);

doc.set_title("My Document");
doc.add_page(Page::a4());

let pdf_bytes = doc.to_bytes().unwrap();
println!("Uncompressed PDF size: {} bytes", pdf_bytes.len());

pub fn enable_xref_streams(&mut self, enable: bool) -> &mut Self

Enable or disable compressed cross-reference streams (PDF 1.5+).

Cross-reference streams provide more compact representation of the cross-reference table and support additional features like compressed object streams.

Arguments

• enable - Whether to enable compressed cross-reference streams

Example

use oxidize_pdf::Document;

let mut doc = Document::new();
doc.enable_xref_streams(true);

pub fn get_compress(&self) -> bool

Gets the current compression setting.

Returns

Returns true if compression is enabled, false otherwise.

pub fn to_bytes(&mut self) -> Result<Vec<u8>>

Generates the PDF document as bytes in memory.

This method provides in-memory PDF generation without requiring file I/O. The document is serialized to bytes and returned as a Vec<u8>.

Returns

Returns the PDF document as bytes on success.

Errors

Returns an error if the document cannot be serialized.

Example

use oxidize_pdf::{Document, Page};

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

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

let pdf_bytes = doc.to_bytes().unwrap();
println!("Generated PDF size: {} bytes", pdf_bytes.len());

pub fn to_bytes_with_config(&mut self, config: WriterConfig) -> Result<Vec<u8>>

Generates the PDF document as bytes with custom writer configuration.

This method allows customizing the PDF output (e.g., using XRef streams) while still generating the document in memory.

Arguments

• config - Writer configuration options

Returns

Returns the PDF document as bytes on success.

Errors

Returns an error if the document cannot be serialized.

Example

use oxidize_pdf::{Document, Page};
use oxidize_pdf::writer::WriterConfig;

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

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

let config = WriterConfig {
    use_xref_streams: true,
    pdf_version: "1.5".to_string(),
    compress_streams: true,
};

let pdf_bytes = doc.to_bytes_with_config(config).unwrap();
println!("Generated PDF size: {} bytes", pdf_bytes.len());

pub fn mark_entity( &mut self, id: impl Into<String>, entity_type: EntityType, bounds: BoundingBox, ) -> String

Mark a region of the PDF with semantic meaning for AI processing.

This creates an AI-Ready PDF that contains machine-readable metadata alongside the visual content, enabling automated document processing.

Example

use oxidize_pdf::{Document, semantic::{EntityType, BoundingBox}};

let mut doc = Document::new();

// Mark an invoice number region
let entity_id = doc.mark_entity(
    "invoice_001".to_string(),
    EntityType::InvoiceNumber,
    BoundingBox::new(100.0, 700.0, 150.0, 20.0, 1)
);

// Add content and metadata
doc.set_entity_content(&entity_id, "INV-2024-001");
doc.add_entity_metadata(&entity_id, "confidence", "0.98");

pub fn set_entity_content( &mut self, entity_id: &str, content: impl Into<String>, ) -> bool

Set the content text for an entity

pub fn add_entity_metadata( &mut self, entity_id: &str, key: impl Into<String>, value: impl Into<String>, ) -> bool

Add metadata to an entity

pub fn set_entity_confidence( &mut self, entity_id: &str, confidence: f32, ) -> bool

Set confidence score for an entity

pub fn relate_entities( &mut self, from_id: &str, to_id: &str, relation_type: RelationType, ) -> bool

Add a relationship between two entities

pub fn get_semantic_entities(&self) -> &[SemanticEntity]

Get all semantic entities in the document

pub fn get_entities_by_type( &self, entity_type: EntityType, ) -> Vec<&SemanticEntity>

Get entities by type

pub fn find_entity(&self, entity_id: &str) -> Option<&SemanticEntity>

Find an entity by ID

pub fn remove_entity(&mut self, entity_id: &str) -> bool

Remove an entity by ID

pub fn semantic_entity_count(&self) -> usize

Get the count of semantic entities

pub fn add_xmp_metadata(&mut self, _xmp_data: &str) -> Result<ObjectId>

Add XMP metadata stream to the document (Pro feature placeholder)

pub fn get_xmp_metadata(&self) -> Result<Option<String>>

Get XMP metadata from the document (Pro feature placeholder)

pub fn extract_text(&self) -> Result<String>

Extract text content from all pages (placeholder implementation)

pub fn extract_page_text(&self, page_index: usize) -> Result<String>

Extract text content from a specific page (placeholder implementation)

Trait Implementations

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.