Skip to main content

PdfStream

Struct PdfStream 

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

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};
use oxidize_pdf::parser::ParseOptions;

// Get decompressed data
let options = ParseOptions::default();
let decoded = stream.decode(&options)?;
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§

Source§

impl PdfStream

Source

pub fn decode(&self, options: &ParseOptions) -> ParseResult<Vec<u8>>

Get the decompressed stream data.

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

§Arguments
  • options - Parse options controlling error recovery behavior
§Returns

The decoded/decompressed stream bytes.

§Errors

Returns an error if:

  • Unknown filter is specified
  • Decompression fails
  • Filter parameters are invalid
§Example
let options = ParseOptions::default();
match stream.decode(&options) {
    Ok(data) => println!("Decoded {} bytes", data.len()),
    Err(e) => println!("Decode error: {}", e),
}
Source

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§

Source§

impl Clone for PdfStream

Source§

fn clone(&self) -> PdfStream

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PdfStream

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PdfStream

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PdfStream

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more