Enum Object 

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

PDF object representation.

Variants

Null

Null object

Boolean(bool)

Boolean value

Integer(i64)

Integer value

Real(f64)

Real (floating-point) value

String(Vec<u8>)

String (byte array)

Name(String)

Name (starting with /)

Array(Vec<Object>)

Array of objects

Dictionary(HashMap<String, Object>)

Dictionary (key-value pairs)

Stream

Stream (dictionary + data)

Fields

dict: HashMap<String, Object>

Stream dictionary

data: Bytes

Stream data

Reference(ObjectRef)

Indirect object reference

Implementations

impl Object

pub fn text_string(s: impl AsRef<str>) -> Self

Create a PDF text string object from a Rust string.

Accepts &str, String, or any type that implements AsRef<str>. Encodes using PDFDocEncoding for characters within U+0000–U+00FF, or UTF-16BE with BOM for strings that contain characters above U+00FF.

pub fn type_name(&self) -> &'static str

Get the type name of this object (without data).

Returns a human-readable type name like “String”, “Array”, “Dictionary”, etc. without including the actual data content.

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

Try to cast to integer.

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

Try to cast to name.

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

Try to cast to dictionary. Works for both Dictionary and Stream objects.

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

Try to cast to array.

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

Try to cast to reference.

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

Try to cast to boolean.

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

Try to cast to real number.

pub fn as_string(&self) -> Option<&[u8]>

Try to cast to string (bytes).

pub fn is_null(&self) -> bool

Check if object is null.

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

Decode stream data using filters specified in the stream dictionary.

This is a convenience method that calls decode_stream_data_with_decryption with no encryption parameters.

Returns

The decoded stream data, or an error if this is not a stream object or if decoding fails.

Examples

use xberg_native_pdf::object::Object;

let decoded_data = stream_obj.decode_stream_data()?;

pub fn decode_stream_data_with_decryption( &self, decryption_fn: Option<&dyn Fn(&[u8]) -> Result<Vec<u8>>>, obj_num: u32, gen_num: u32, ) -> Result<Vec<u8>>

Decode stream data with optional decryption.

PDF Spec: Section 7.6.2 - General Encryption Algorithm states that streams must be decrypted BEFORE applying filters (decompression).

Arguments

• decryption_fn - Optional decryption function (from EncryptionHandler)
• obj_num - Object number (for encryption key derivation)
• gen_num - Generation number (for encryption key derivation)

Returns

The decoded stream data, or an error if decoding/decryption fails.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Self

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.

impl PartialEq for Object

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Object