Struct Dict 

pub struct Dict(/* private fields */);

A PDF dictionary: key-value pairs in document order.

Streams as values

ISO 32000-1 §7.3.8.1 forbids a file from writing a stream as a direct dictionary value, and the reader drops one found inline while parsing. That is a file-format constraint, not an in-memory invariant, and this type does not police it: Object::clone_direct flattens references, so a /Resources whose /XObject entries are indirect streams clones into a dictionary holding those streams directly, and Dict::stream reads such a value back. Enforcing §7.3.8.1 is the writer’s job: pdfrum-edit hoists a direct stream to an indirect object at serialization time.

use pdfrum_object::{Dict, NoResolve, Object, names};

let dict = Dict::from_pairs([
    (names::TYPE.clone(), Object::Name(names::PAGE.clone())),
    (names::COUNT.clone(), Object::Int(3)),
]);
assert_eq!(dict.name(names::TYPE), Some(names::PAGE));
assert_eq!(dict.int(names::COUNT, &NoResolve), Some(3));
assert_eq!(dict.len(), 2);

Implementations

impl Dict

pub fn new() -> Self

An empty dictionary.

pub fn from_pairs(pairs: impl IntoIterator<Item = (Name, Object)>) -> Self

A dictionary from key-value pairs, keeping their order.

pub fn push(&mut self, key: Name, value: Object)

Append a pair, keeping any earlier entry with the same key.

The later entry wins on lookup, so appending is how a reader records a duplicate key without losing what the file actually said.

Any object, a stream included — see the type-level note on §7.3.8.1.

pub fn insert(&mut self, key: Name, value: Object)

Sets key to value: replaces the existing entry in place, keeping its position, or appends.

pub fn remove(&mut self, key: &Name) -> Option<Object>

Removes key, returning its value; None when absent.

pub fn len(&self) -> usize

Number of stored pairs, duplicates included.

pub fn is_empty(&self) -> bool

Whether the dictionary has no pairs.

pub fn iter(&self) -> impl Iterator<Item = &(Name, Object)>

The pairs, in document order.

pub fn keys(&self) -> impl Iterator<Item = &Name>

The keys, in document order, duplicates included.

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

Whether any entry carries this key.

pub fn raw(&self, key: &Name) -> Option<&Object>

The stored value, whatever its type, without resolving references.

The last entry with this key wins.

pub fn direct_int(&self, key: &Name) -> Option<i64>

The value of a Number-typed entry in the C-integer view, without resolving.

This is how the cross-reference reader reads /Size, /Prev and /XRefStm: an indirect value there is ignored rather than chased, which is deliberate recovery behavior in files whose trailer points at objects the table cannot yet describe.

pub fn name(&self, key: &Name) -> Option<&Name>

The name a Name-typed entry holds, without resolving.

A reference here reads as absent: the type check happens before any resolution, so /Type 5 0 R never names a type.

pub fn bool(&self, key: &Name) -> Option<bool>

The value of a Boolean-typed entry, without resolving.

An Int(1) is not a boolean and reads as absent.

pub fn number_obj(&self, key: &Name) -> Option<&Object>

A Number-typed entry as an object, without resolving. Used where the distinction between “not a number” and “zero” matters, such as validating a cross-reference stream’s /Index.

pub fn string(&self, key: &Name) -> Option<&PdfString>

The string a String-typed entry holds, without resolving.

pub fn get<'a>(&'a self, key: &Name, r: &impl Resolve) -> Option<Resolved<'a>>

The value, following one level of indirection.

Returns None for a missing key and for a reference the store cannot produce — both are absence — and the store records the underlying failure in its diagnostics.

pub fn int(&self, key: &Name, r: &impl Resolve) -> Option<i64>

The integer value of an entry of any type, in the C-integer view.

Coerces: booleans read as 0 and 1, reals truncate. A reference is followed one level, and a reference to a reference reads as absent.

pub fn number(&self, key: &Name, r: &impl Resolve) -> Option<f32>

The numeric value of an entry, coercing integers to f32.

pub fn byte_string(&self, key: &Name, r: &impl Resolve) -> Option<Vec<u8>>

The byte-string spelling of an entry of any type — see Object::to_byte_string.

pub fn text(&self, key: &Name, r: &impl Resolve) -> Option<String>

An entry read as text — see Object::to_text.

pub fn dict(&self, key: &Name, r: &impl Resolve) -> Option<Dict>

The dictionary an entry holds, following one level of indirection.

A stream answers with its own dictionary, so /Pages pointing at either a dictionary or a stream reads the same way.

Returns an owned clone because the dictionary may live inside an Arc the store owns; dictionaries are small and this keeps the borrow story simple for callers.

pub fn array(&self, key: &Name, r: &impl Resolve) -> Option<Array>

The array an entry holds, following one level of indirection.

pub fn stream(&self, key: &Name, r: &impl Resolve) -> Option<Stream>

The stream an entry holds, following one level of indirection.

pub fn reference(&self, key: &Name) -> Option<ObjRef>

The reference an entry holds, without resolving it.

pub fn rect(&self, key: &Name, r: &impl Resolve) -> Rect

A rectangle read from a four-element array — see Array::as_rect.

Missing or malformed yields the zero rectangle, never None: PDF consumers of /MediaBox and friends all want a rectangle.

pub fn matrix(&self, key: &Name, r: &impl Resolve) -> Affine

A transformation matrix read from a six-element array — see Array::as_matrix. Missing or malformed yields the identity.

Trait Implementations

impl Clone for Dict

fn clone(&self) -> Dict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dict

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

Formats the value using the given formatter.

impl Default for Dict

fn default() -> Dict

Returns the “default value” for a type.

impl From<Dict> for Object

fn from(v: Dict) -> Self

Converts to this type from the input type.

impl FromIterator<(Name, Object)> for Dict

fn from_iter<I: IntoIterator<Item = (Name, Object)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Dict

type Item = &'a (Name, Object)

The type of the elements being iterated over.

type IntoIter = Iter<'a, (Name, Object)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Dict

fn eq(&self, other: &Dict) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Dict