Enum Object 

pub enum Object {
    Null,
    Boolean(bool),
    Integer(i64),
    Real(f64),
    String(PdfString),
    Name(Name),
    Array(Vec<Object>),
    Dictionary(HashMap<Name, Object>),
    Stream {
        dict: HashMap<Name, Object>,
        data: StreamData,
    },
    Reference(ObjectId),
}

A PDF object value.

Object::Reference holds an unresolved indirect reference — it is not recursively resolved at parse time to avoid OnceLock deadlocks.

Variants

Null

The PDF null object.

Boolean(bool)

A boolean value.

Integer(i64)

An integer number.

Real(f64)

A real (floating-point) number.

String(PdfString)

A PDF string (encoding-aware).

Name(Name)

A PDF name.

Array(Vec<Object>)

An array of objects.

Dictionary(HashMap<Name, Object>)

A dictionary mapping names to objects.

Stream

A stream object with dictionary metadata and raw data reference.

Fields

dict: HashMap<Name, Object>

data: StreamData

Reference(ObjectId)

An unresolved indirect reference to another object.

Implementations

impl Object

pub fn as_bool(&self) -> Option<bool>

Returns the boolean value if this is Object::Boolean.

pub fn as_boolean(&self) -> Option<bool>

ADR-019 alias for as_bool().

Corresponds to CPDF_Object::GetBooleanValue.

pub fn as_i64(&self) -> Option<i64>

Returns the integer value if this is Object::Integer.

pub fn as_f64(&self) -> Option<f64>

Returns the floating-point value if this is Object::Real or Object::Integer.

pub fn as_string(&self) -> Option<&PdfString>

Returns a reference to the PdfString if this is Object::String.

pub fn as_name(&self) -> Option<&Name>

Returns a reference to the Name if this is Object::Name.

pub fn as_array(&self) -> Option<&[Object]>

Returns a reference to the array if this is Object::Array.

pub fn as_dict(&self) -> Option<&HashMap<Name, Object>>

Returns a reference to the dictionary if this is Object::Dictionary.

pub fn as_dictionary(&self) -> Option<&HashMap<Name, Object>>

ADR-019 alias for as_dict().

Corresponds to CPDF_Object::AsDictionary.

pub fn as_stream_dict(&self) -> Option<&HashMap<Name, Object>>

Returns a reference to the stream dictionary if this is Object::Stream.

pub fn as_reference(&self) -> Option<ObjectId>

Returns the ObjectId if this is Object::Reference.

pub fn as_dict_mut(&mut self) -> Option<&mut HashMap<Name, Object>>

Returns a mutable reference to the dictionary if this is Object::Dictionary.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Object>>

Returns a mutable reference to the array if this is Object::Array.

pub fn is_null(&self) -> bool

Returns true if this is Object::Null.

pub fn is_reference(&self) -> bool

Returns true if this is Object::Reference.

pub fn is_boolean(&self) -> bool

Returns true if this is Object::Boolean.

Corresponds to CPDF_Object::IsBoolean() in PDFium.

pub fn is_number(&self) -> bool

Returns true if this is Object::Integer or Object::Real.

Corresponds to CPDF_Object::IsNumber() in PDFium.

pub fn is_string(&self) -> bool

Returns true if this is Object::String.

Corresponds to CPDF_Object::IsString() in PDFium.

pub fn is_name(&self) -> bool

Returns true if this is Object::Name.

Corresponds to CPDF_Object::IsName() in PDFium.

pub fn is_array(&self) -> bool

Returns true if this is Object::Array.

Corresponds to CPDF_Object::IsArray() in PDFium.

pub fn is_dictionary(&self) -> bool

Returns true if this is Object::Dictionary.

Corresponds to CPDF_Object::IsDictionary() in PDFium.

pub fn is_stream(&self) -> bool

Returns true if this is Object::Stream.

Corresponds to CPDF_Object::IsStream() in PDFium.

pub fn get_integer(&self) -> Option<i64>

Upstream-aligned alias for Self::as_i64().

Returns the integer value if this is Object::Integer. Corresponds to CPDF_Object::GetInteger() in PDFium.

pub fn get_number(&self) -> Option<f64>

Upstream-aligned alias for Self::as_f64().

Returns the numeric value as f64 for Object::Real or Object::Integer. Corresponds to CPDF_Object::GetNumber() in PDFium.

pub fn get_string(&self) -> Option<&PdfString>

Upstream-aligned alias for Self::as_string().

Returns a reference to the PdfString if this is Object::String. Corresponds to CPDF_Object::GetString() in PDFium.

pub fn unicode_text(&self) -> Option<String>

Returns the string value decoded to a UTF-8 String, if this is a Object::String or Object::Name.

Corresponds to CPDF_Object::GetUnicodeText() in PDFium.

pub fn get_unicode_text(&self) -> Option<String>

Upstream-aligned alias for Self::unicode_text().

Corresponds to CPDF_Object::GetUnicodeText() in PDFium.

pub fn is_integer(&self) -> bool

Returns true if this is Object::Integer (a whole number, not real).

Corresponds to CPDF_Number::IsInteger() in PDFium.

pub fn ref_obj_num(&self) -> Option<u32>

Returns the object number of the indirect reference if this is Object::Reference.

Corresponds to CPDF_Reference::GetRefObjNum() in PDFium.

pub fn get_ref_obj_num(&self) -> Option<u32>

Upstream-aligned alias for Self::ref_obj_num().

Corresponds to CPDF_Reference::GetRefObjNum() in PDFium.

pub fn raw_size(&self) -> Option<u64>

Returns the raw (encoded) byte size of the stream data if this is Object::Stream.

• For StreamData::Raw, returns the length stored at parse time.
• For StreamData::Decoded, returns the byte length of the in-memory buffer.

Corresponds to CPDF_Stream::GetRawSize() in PDFium.

pub fn get_raw_size(&self) -> Option<u64>

Upstream-aligned alias for Self::raw_size().

Corresponds to CPDF_Stream::GetRawSize() in PDFium.

pub fn has_filter(&self) -> bool

Returns true if this stream has a /Filter entry in its dictionary.

Corresponds to CPDF_Stream::HasFilter() in PDFium.

pub fn array_len(&self) -> Option<usize>

Returns the number of elements if this is Object::Array, otherwise None.

Corresponds to CPDF_Array::size() in PDFium.

pub fn array_size(&self) -> Option<usize>

👎Deprecated since 0.0.0:

use array_len()

Variant name for Self::array_len().

Corresponds to CPDF_Array::size() in PDFium, but the exact snake_case of that method is size(), which would be ambiguous on the unified Object type. Use array_len() instead.

pub fn array_is_empty(&self) -> bool

Returns true if this is an Object::Array with no elements.

Corresponds to CPDF_Array::IsEmpty() in PDFium.

pub fn dict_len(&self) -> Option<usize>

Returns the number of key–value pairs if this is Object::Dictionary, otherwise None.

Corresponds to CPDF_Dictionary::size() in PDFium.

pub fn dict_size(&self) -> Option<usize>

👎Deprecated since 0.0.0:

use dict_len()

Variant name for Self::dict_len().

Corresponds to CPDF_Dictionary::size() in PDFium, but the exact snake_case of that method is size(), which would be ambiguous on the unified Object type. Use dict_len() instead.

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

Returns true if the dictionary contains key.

Returns false for non-dictionary objects.

Corresponds to CPDF_Dictionary::KeyExist() in PDFium.

pub fn keys(&self) -> Option<Vec<&Name>>

Returns the list of keys if this is Object::Dictionary, otherwise None.

Corresponds to CPDF_Dictionary::GetKeys() in PDFium.

pub fn get_keys(&self) -> Option<Vec<&Name>>

Upstream-aligned alias for Self::keys().

Corresponds to CPDF_Dictionary::GetKeys() in PDFium.

pub fn dict(&self) -> Option<&HashMap<Name, Object>>

Returns the dictionary of this object:

• If Object::Dictionary, returns the dictionary.
• If Object::Stream, returns the stream dictionary.
• Otherwise returns None.

Corresponds to CPDF_Object::GetDict() in PDFium.

pub fn get_dict(&self) -> Option<&HashMap<Name, Object>>

Upstream-aligned alias for Self::dict().

Corresponds to CPDF_Object::GetDict() in PDFium.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.