Struct zstd::stream::write::Encoder

pub struct Encoder<'a, W: Write> { /* private fields */ }

An encoder that compress and forward data to another writer.

This allows to compress a stream of data (good for files or heavy network stream).

Don’t forget to call finish() before dropping it!

Alternatively, you can call auto_finish() to use an AutoFinishEncoder that will finish on drop.

Note: The zstd library has its own internal input buffer (~128kb).

Implementations

impl<W: Write> Encoder<'static, W>

pub fn new(writer: W, level: i32) -> Result<Self>

Creates a new encoder.

level: compression level (1-21).

A level of 0 uses zstd’s default (currently 3).

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

Creates a new encoder, using an existing dictionary.

(Provides better compression ratio for small files, but requires the dictionary to be present during decompression.)

A level of 0 uses zstd’s default (currently 3).

impl<'a, W: Write> Encoder<'a, W>

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

Creates a new encoder, using an existing prepared EncoderDictionary.

(Provides better compression ratio for small files, but requires the dictionary to be present during decompression.)

pub fn auto_finish(self) -> AutoFinishEncoder<'a, W>

Returns a wrapper around self that will finish the stream on drop.

Panic

Panics on drop if an error happens when finishing the stream.

pub fn on_finish<F: FnMut(Result<W>)>(self, f: F) -> AutoFinishEncoder<'a, W, F>

Returns an encoder that will finish the stream on drop.

Calls the given callback with the result from finish().

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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

Acquires a mutable reference to the underlying writer.

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

pub fn finish(self) -> Result<W>

Required: Finishes the stream.

You need to finish the stream when you’re done writing, either with this method or with try_finish(self).

This returns the inner writer in case you need it.

To get back self in case an error happened, use try_finish.

Note: If you don’t want (or can’t) call finish() manually after writing your data, consider using auto_finish() to get an AutoFinishEncoder.

pub fn try_finish(self) -> Result<W, (Self, Error)>

Required: Attempts to finish the stream.

You need to finish the stream when you’re done writing, either with this method or with finish(self).

This returns the inner writer if the finish was successful, or the object plus an error if it wasn’t.

write on this object will panic after try_finish has been called, even if it fails.

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

Attemps to finish the stream.

You need to finish the stream when you’re done writing, either with this method or with finish(self).

pub fn recommended_input_size() -> usize

Return a recommendation for the size of data to write at once.

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

Sets the given zstd compression parameter.

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

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

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

pub fn multithread(&mut self, n_workers: u32) -> Result<()>

Available on crate feature zstdmt only.

Enables multithreaded compression

• If n_workers == 0 (default), then multithreaded will be disabled.
• If n_workers >= 1, then compression will be done in separate threads.

So even n_workers = 1 may increase performance by separating IO and compression.

Note: This is only available if the zstdmt cargo feature is activated.

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.

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.

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

Enables or disables long-distance matching

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.

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

Available on crate feature experimental only.

Enables or disable the magic bytes at the beginning of each frame.

If disabled, include_magicbytes must also be called on the decoder.

Only available with the experimental feature.

Note that decompression will need to use the same setting.

Trait Implementations

impl<'a, W: Write> Write for Encoder<'a, W>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adapter for this instance of Write.