Struct PdfStream

pub struct PdfStream {
    pub dict: PdfDictionary,
    pub data: Vec<u8>,
}

PDF Stream object - Dictionary with associated binary data.

Streams are used for large data blocks like page content, images, fonts, etc. The dictionary describes the stream’s properties (length, filters, etc.).

Structure

• dict: Stream dictionary with metadata
• data: Raw stream bytes (possibly compressed)

Common Stream Types

• Content streams: Page drawing instructions
• Image XObjects: Embedded images
• Font programs: Embedded font data
• Form XObjects: Reusable graphics

Example

use oxidize_pdf::parser::objects::{PdfStream, PdfDictionary};

// Get decompressed data
let decoded = stream.decode()?;
println!("Decoded {} bytes", decoded.len());

// Access raw data
let raw = stream.raw_data();
println!("Raw {} bytes", raw.len());

Fields

dict: PdfDictionary

Stream dictionary containing Length, Filter, and other properties

data: Vec<u8>

Raw stream data (may be compressed)

Implementations

impl PdfStream

pub fn decode(&self) -> ParseResult<Vec<u8>>

Get the decompressed stream data.

Automatically applies filters specified in the stream dictionary (FlateDecode, ASCIIHexDecode, etc.) to decompress the data.

Returns

The decoded/decompressed stream bytes.

Errors

Returns an error if:

• Unknown filter is specified
• Decompression fails
• Filter parameters are invalid

Example

match stream.decode() {
    Ok(data) => println!("Decoded {} bytes", data.len()),
    Err(e) => println!("Decode error: {}", e),
}

pub fn raw_data(&self) -> &[u8]

Get the raw (possibly compressed) stream data.

Returns the stream data exactly as stored in the PDF file, without applying any filters or decompression.

Example

let raw_data = stream.raw_data();
println!("Raw stream: {} bytes", raw_data.len());

Trait Implementations

impl Clone for PdfStream

fn clone(&self) -> PdfStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfStream

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

Formats the value using the given formatter.

impl PartialEq for PdfStream

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