Enum PdfObject

pub enum PdfObject {
    Null,
    Boolean(bool),
    Integer(i64),
    Real(f64),
    String(PdfString),
    Name(PdfName),
    Array(PdfArray),
    Dictionary(PdfDictionary),
    Stream(PdfStream),
    Reference(u32, u16),
}

PDF Object types - The fundamental data types in PDF.

All data in a PDF file is represented using these basic types. Objects can be direct (embedded) or indirect (referenced).

Object Types

• Null - Undefined/absent value
• Boolean - true or false
• Integer - Signed integers
• Real - Floating-point numbers
• String - Text or binary data
• Name - Atomic symbols like /Type
• Array - Ordered collections
• Dictionary - Key-value maps
• Stream - Dictionary + binary data
• Reference - Indirect object reference (num gen R)

Example

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

// Different object types
let null = PdfObject::Null;
let bool_val = PdfObject::Boolean(true);
let int_val = PdfObject::Integer(42);
let real_val = PdfObject::Real(3.14159);
let name = PdfObject::Name(PdfName::new("Type".to_string()));
let reference = PdfObject::Reference(10, 0); // 10 0 R

// Type checking
assert!(int_val.as_integer().is_some());
assert_eq!(int_val.as_integer(), Some(42));

Variants

Null

Null object - represents undefined or absent values

Boolean(bool)

Boolean value - true or false

Integer(i64)

Integer number

Real(f64)

Real (floating-point) number

String(PdfString)

String data (literal or hexadecimal)

Name(PdfName)

Name object - unique identifier

Array(PdfArray)

Array - ordered collection of objects

Dictionary(PdfDictionary)

Dictionary - unordered key-value pairs

Stream(PdfStream)

Stream - dictionary with binary data

Reference(u32, u16)

Indirect object reference (object_number, generation_number)

Implementations

impl PdfObject

pub fn parse<R: Read>(lexer: &mut Lexer<R>) -> ParseResult<Self>

Parse a PDF object from a lexer.

Reads tokens from the lexer and constructs the appropriate PDF object. Handles all PDF object types including indirect references.

Arguments

• lexer - Token source for parsing

Returns

The parsed PDF object.

Errors

Returns an error if:

• Invalid syntax is encountered
• Unexpected end of input
• Malformed object structure

Example

use oxidize_pdf_core::parser::lexer::Lexer;
use oxidize_pdf_core::parser::objects::PdfObject;
use std::io::Cursor;

let input = b"42";
let mut lexer = Lexer::new(Cursor::new(input));
let obj = PdfObject::parse(&mut lexer)?;
assert_eq!(obj, PdfObject::Integer(42));

pub fn is_null(&self) -> bool

Check if this object is null.

Example

use oxidize_pdf_core::parser::objects::PdfObject;

assert!(PdfObject::Null.is_null());
assert!(!PdfObject::Integer(42).is_null());

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

Get the value as a boolean if this is a Boolean object.

Returns

Some(bool) if this is a Boolean object, None otherwise.

Example

use oxidize_pdf_core::parser::objects::PdfObject;

let obj = PdfObject::Boolean(true);
assert_eq!(obj.as_bool(), Some(true));

let obj = PdfObject::Integer(1);
assert_eq!(obj.as_bool(), None);

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

Get as integer

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

Get the value as a real number.

Returns the value for both Real and Integer objects, converting integers to floating-point.

Returns

Some(f64) if this is a numeric object, None otherwise.

Example

use oxidize_pdf_core::parser::objects::PdfObject;

let real_obj = PdfObject::Real(3.14);
assert_eq!(real_obj.as_real(), Some(3.14));

let int_obj = PdfObject::Integer(42);
assert_eq!(int_obj.as_real(), Some(42.0));

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

Get as string

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

Get as name

pub fn as_array(&self) -> Option<&PdfArray>

Get as array

pub fn as_dict(&self) -> Option<&PdfDictionary>

Get as dictionary

pub fn as_stream(&self) -> Option<&PdfStream>

Get as stream

pub fn as_reference(&self) -> Option<(u32, u16)>

Get the object reference if this is a Reference object.

Returns

Some((object_number, generation_number)) if this is a Reference, None otherwise.

Example

use oxidize_pdf_core::parser::objects::PdfObject;

let obj = PdfObject::Reference(10, 0);
assert_eq!(obj.as_reference(), Some((10, 0)));

// Use for resolving references
if let Some((obj_num, gen_num)) = obj.as_reference() {
    println!("Reference to {} {} R", obj_num, gen_num);
}

Trait Implementations

impl Clone for PdfObject

fn clone(&self) -> PdfObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfObject

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

Formats the value using the given formatter.

impl PartialEq for PdfObject

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