Struct zstd::stream::read::Encoder

source ·
pub struct Encoder<'a, R> { /* private fields */ }
Expand description

An encoder that compress input data from another Read.

Implementations§

source§

impl<R: Read> Encoder<'static, BufReader<R>>

source

pub fn new(reader: R, level: i32) -> Result<Self>

Creates a new encoder.

source§

impl<R: BufRead> Encoder<'static, R>

source

pub fn with_buffer(reader: R, level: i32) -> Result<Self>

Creates a new encoder around a BufRead.

source

pub fn with_dictionary(reader: R, level: i32, dictionary: &[u8]) -> Result<Self>

Creates a new encoder, using an existing dictionary.

The dictionary must be the same as the one used during compression.

source§

impl<'a, R: BufRead> Encoder<'a, R>

source

pub fn with_prepared_dictionary<'b>( reader: R, dictionary: &EncoderDictionary<'b>, ) -> Result<Self>
where 'b: 'a,

Creates a new encoder, using an existing EncoderDictionary.

The dictionary must be the same as the one used during compression.

source

pub fn recommended_output_size() -> usize

Recommendation for the size of the output buffer.

source

pub fn get_ref(&self) -> &R

Acquire a reference to the underlying reader.

source

pub fn get_mut(&mut self) -> &mut R

Acquire a mutable reference to the underlying reader.

Note that mutation of the reader may result in surprising results if this encoder is continued to be used.

source

pub fn flush(&mut self, out: &mut [u8]) -> Result<usize>

Flush any internal buffer.

This ensures all input consumed so far is compressed.

Since it prevents bundling currently buffered data with future input, it may affect compression ratio.

  • Returns the number of bytes written to out.
  • Returns Ok(0) when everything has been flushed.
source

pub fn finish(self) -> R

Return the inner Read.

Calling finish() is not required after reading a stream - just use it if you need to get the Read back.

source

pub fn set_parameter(&mut self, parameter: CParameter) -> Result<()>

Sets the given zstd compression parameter.

source

pub fn set_pledged_src_size(&mut self, size: Option<u64>) -> Result<()>

Sets the expected size of the input.

This affects the compression effectiveness.

It is an error to give an incorrect size (an error will be returned when closing the stream if the size does not match what was pledged).

Giving a None size means the size is unknown (this is the default).

source

pub fn include_checksum(&mut self, include_checksum: bool) -> Result<()>

Controls whether zstd should include a content checksum at the end of each frame.

source

pub fn include_dictid(&mut self, include_dictid: bool) -> Result<()>

Enables or disables storing of the dict id.

Defaults to true. If false, the behaviour of decoding with a wrong dictionary is undefined.

source

pub fn include_contentsize(&mut self, include_contentsize: bool) -> Result<()>

Enables or disabled storing of the contentsize.

Note that this only has an effect if the size is given with set_pledged_src_size.

source

pub fn long_distance_matching( &mut self, long_distance_matching: bool, ) -> Result<()>

Enables or disables long-distance matching

source

pub fn set_target_cblock_size(&mut self, target_size: Option<u32>) -> Result<()>

Sets the target size for compressed blocks.

A lower block size may result in slightly lower speed (~2%) and compression ratio (~0.1%), but may decrease end-to-end latency in low-bandwidth environments (time to first decompressed byte).

No value, or a value of zero, results in no contraint for the block sizes.

source

pub fn window_log(&mut self, log_distance: u32) -> Result<()>

Sets the maximum back-reference distance.

The actual maximum distance is going to be 2^log_distance.

Note that decompression will need to use at least the same setting.

Trait Implementations§

source§

impl<R: BufRead> Read for Encoder<'_, R>

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<'a, R> Freeze for Encoder<'a, R>
where R: Freeze,

§

impl<'a, R> RefUnwindSafe for Encoder<'a, R>
where R: RefUnwindSafe,

§

impl<'a, R> Send for Encoder<'a, R>
where R: Send,

§

impl<'a, R> Sync for Encoder<'a, R>
where R: Sync,

§

impl<'a, R> Unpin for Encoder<'a, R>
where R: Unpin,

§

impl<'a, R> !UnwindSafe for Encoder<'a, R>

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.

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.