Struct lopdf::Stream

source ·
pub struct Stream {
    pub dict: Dictionary,
    pub content: Vec<u8>,
    pub allows_compression: bool,
    pub start_position: Option<usize>,
}
Expand description

Stream object Warning - all streams must be indirect objects, while the stream dictionary may be a direct object

Fields§

§dict: Dictionary

Associated stream dictionary

§content: Vec<u8>

Contents of the stream in bytes

§allows_compression: bool

Can the stream be compressed by the Document::compress() function? Font streams may not be compressed, for example

§start_position: Option<usize>

Stream data’s position in PDF file.

Implementations§

source§

impl Stream

source

pub fn new(dict: Dictionary, content: Vec<u8>) -> Stream

source

pub fn with_position(dict: Dictionary, position: usize) -> Stream

source

pub fn with_compression(self, allows_compression: bool) -> Stream

Default is that the stream may be compressed. On font streams, set this to false, otherwise the font will be corrupt

source

pub fn filter(&self) -> Result<String>

source

pub fn filters(&self) -> Result<Vec<String>>

source

pub fn set_content(&mut self, content: Vec<u8>)

source

pub fn set_plain_content(&mut self, content: Vec<u8>)

source

pub fn compress(&mut self) -> Result<()>

source

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

source

pub fn decompress(&mut self)

source§

impl Stream

source

pub fn decode_content(&self) -> Result<Content<Vec<Operation>>>

Decode content after decoding all stream filters.

Trait Implementations§

source§

impl Clone for Stream

source§

fn clone(&self) -> Stream

Returns a copy 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 Stream

source§

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

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

impl From<Stream> for Object

source§

fn from(stream: Stream) -> Self

Converts to this type from the input type.
source§

impl PartialEq for Stream

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Stream

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> 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

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

§

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

§

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.