Skip to main content

Stream

Struct Stream 

Source
pub struct Stream { /* private fields */ }
Expand description

A stream object: a dictionary plus the raw bytes between stream and endstream.

The data is kept exactly as it appears in the file — still encoded, still encrypted if the document is. Decoding is the filter layer’s job (Q4); decryption is Q9’s, and both use Stream::set_data so that /Length never drifts away from the bytes.

Implementations§

Source§

impl Stream

Source

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

Decode this stream’s payload with its own /Filter and /DecodeParms.

Fails when either entry is indirect — use crate::Document::decode_stream for that case.

Source§

impl Stream

Source

pub fn new(dict: Dictionary, data: impl Into<Vec<u8>>) -> Self

A stream from a dictionary and its raw data.

/Length is not rewritten here: the dictionary is used exactly as given, which is what a parsed stream needs for a byte-exact write-back.

Source

pub fn dict(&self) -> &Dictionary

The stream dictionary.

Source

pub fn dict_mut(&mut self) -> &mut Dictionary

The stream dictionary, for in-place edits.

Source

pub fn data(&self) -> &[u8] ⓘ

The raw stream bytes, as stored in the file.

Source

pub fn into_data(self) -> Vec<u8> ⓘ

Consume the stream and return its raw bytes.

Source

pub fn set_data(&mut self, data: impl Into<Vec<u8>>)

Replace the raw data and keep /Length in step with it.

Used after decoding or decrypting, when the bytes change but the dictionary must stay consistent with what would be written out.

Trait Implementations§

Source§

impl Clone for Stream

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Stream

Source§

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

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

impl PartialEq for Stream

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Stream

Auto Trait Implementations§

§

impl Forget for Stream

§

impl Freeze for Stream

§

impl Move for Stream

§

impl RefUnwindSafe for Stream

§

impl Send for Stream

§

impl Sync for Stream

§

impl Unpin for Stream

§

impl UnsafeUnpin for Stream

§

impl UnwindSafe for Stream

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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.