Struct StreamObject 

#[non_exhaustive]
pub struct StreamObject {
    pub dictionary: Dictionary,
    pub raw_range: StreamRange,
    pub declared_length: Option<u64>,
    pub discovered_length: u64,
    pub filters: Vec<PdfName>,
    pub decode_params: Vec<DecodeParams>,
    pub raw_source: Arc<[u8]>,
    pub stream_keyword_crlf_compliant: bool,
    pub endstream_keyword_eol_compliant: bool,
}

Parsed stream object with raw byte range metadata.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dictionary: Dictionary

Stream dictionary.

raw_range: StreamRange

Range of raw stream bytes within the input.

declared_length: Option<u64>

Declared stream length.

discovered_length: u64

Length discovered by scanning to endstream.

filters: Vec<PdfName>

Stream filters as name objects.

decode_params: Vec<DecodeParams>

Structured decode parameters aligned with filters.

raw_source: Arc<[u8]>

Shared source bytes used for lazy stream decoding.

stream_keyword_crlf_compliant: bool

Whether the stream keyword is followed by CRLF.

endstream_keyword_eol_compliant: bool

Whether endstream is preceded by an EOL marker.

Implementations

impl StreamObject

pub fn decoded_bytes( &self, limits: &ResourceLimits, ) -> Result<Vec<u8>, ParseError>

Returns decoded stream bytes, enforcing max_stream_decode_bytes.

Errors

Returns ParseError when a filter is unsupported, decompression fails, or decoded output exceeds the configured limit.

Trait Implementations

impl Clone for StreamObject

fn clone(&self) -> StreamObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamObject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StreamObject

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamObject