Struct PdfDictionary

pub struct PdfDictionary(pub HashMap<PdfName, PdfObject>);

PDF Dictionary object - Key-value mapping with name keys.

Dictionaries are the primary way to represent complex data structures in PDF. Keys must be PdfName objects, values can be any PDF object type.

Common Dictionary Types

• Catalog: Document root (/Type /Catalog)
• Page: Individual page (/Type /Page)
• Font: Font definition (/Type /Font)
• Stream: Binary data with metadata

Example

use oxidize_pdf_core::parser::objects::{PdfDictionary, PdfObject, PdfName};

let mut page_dict = PdfDictionary::new();
page_dict.insert("Type".to_string(), 
    PdfObject::Name(PdfName::new("Page".to_string())));
page_dict.insert("Parent".to_string(), 
    PdfObject::Reference(2, 0)); // Reference to pages tree

// Access values
assert_eq!(page_dict.get_type(), Some("Page"));
assert!(page_dict.contains_key("Parent"));

Tuple Fields

0: HashMap<PdfName, PdfObject>

Implementations

impl PdfDictionary

pub fn new() -> Self

Create a new empty dictionary.

Example

use oxidize_pdf_core::parser::objects::{PdfDictionary, PdfObject, PdfName};

let mut dict = PdfDictionary::new();
dict.insert("Type".to_string(), PdfObject::Name(PdfName::new("Font".to_string())));

pub fn get(&self, key: &str) -> Option<&PdfObject>

Get a value by key name.

Arguments

• key - The key name (without leading slash)

Returns

Reference to the value if the key exists, None otherwise.

Example

use oxidize_pdf_core::parser::objects::{PdfDictionary, PdfObject};

let mut dict = PdfDictionary::new();
dict.insert("Length".to_string(), PdfObject::Integer(1000));

if let Some(length) = dict.get("Length").and_then(|o| o.as_integer()) {
    println!("Stream length: {}", length);
}

pub fn insert(&mut self, key: String, value: PdfObject)

Insert a key-value pair

pub fn contains_key(&self, key: &str) -> bool

Check if dictionary contains a key

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

Get the dictionary type (value of /Type key).

Many PDF dictionaries have a /Type entry that identifies their purpose.

Returns

The type name if present, None otherwise.

Common Types

• “Catalog” - Document catalog
• “Page” - Page object
• “Pages” - Page tree node
• “Font” - Font dictionary
• “XObject” - External object

Example

use oxidize_pdf_core::parser::objects::{PdfDictionary, PdfObject, PdfName};

let mut dict = PdfDictionary::new();
dict.insert("Type".to_string(), PdfObject::Name(PdfName::new("Page".to_string())));
assert_eq!(dict.get_type(), Some("Page"));

Trait Implementations

impl Clone for PdfDictionary

fn clone(&self) -> PdfDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfDictionary

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

Formats the value using the given formatter.

impl Default for PdfDictionary

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PdfDictionary

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