Struct PdfStream 

pub struct PdfStream {
    pub dict: PdfDict,
    pub data: Vec<u8>,
    /* private fields */
}

A PDF stream object

Streams are used to represent large or binary data in PDF. They consist of a dictionary that describes the data, followed by the raw bytes enclosed between stream and endstream keywords.

Fields

dict: PdfDict

The stream dictionary containing metadata

data: Vec<u8>

The raw (possibly encoded) data

Implementations

impl PdfStream

pub fn new(dict: PdfDict, data: Vec<u8>) -> Self

Creates a new stream with the given dictionary and data

pub fn from_data(data: Vec<u8>) -> Self

Creates a new stream with data and default dictionary

pub fn from_data_compressed(data: Vec<u8>) -> Self

Creates a new stream with compressed data

pub fn dict(&self) -> &PdfDict

Returns the stream dictionary

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

Returns a mutable reference to the stream dictionary

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

Returns the raw stream data

pub fn encoded_length(&self) -> usize

Returns the length of the encoded data

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

Decodes the stream data if it’s compressed

pub fn update_length(&mut self)

Updates the Length entry in the dictionary

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

Sets the stream data and updates the length

pub fn is_filtered(&self) -> bool

Returns true if the stream has a filter applied

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

Gets the filter name if present

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 Display for PdfStream

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

Formats the value using the given formatter.

impl From<&[u8]> for PdfStream

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for PdfStream

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<PdfStream> for PdfObject

fn from(s: PdfStream) -> Self

Converts to this type from the input type.

impl From<String> for PdfStream

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for PdfStream

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

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