Struct zstd::stream::raw::Encoder

pub struct Encoder<'a> { /* private fields */ }

An in-memory encoder for streams of data.

Implementations

impl Encoder<'static>

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

Creates a new encoder.

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

Creates a new encoder initialized with the given dictionary.

impl<'a> Encoder<'a>

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

Creates a new encoder using an existing EncoderDictionary.

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

Sets a compression parameter for this encoder.

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

Sets the size of the input expected by zstd.

May affect compression ratio.

It is an error to give an incorrect size (an error will be returned when closing the stream).

If None is given, it assume the size is not known (default behaviour).

Trait Implementations

impl<'a> Operation for Encoder<'a>

fn run<C: WriteBuf + ?Sized>(
    &mut self,
    input: &mut InBuffer<'_>,
    output: &mut OutBuffer<'_, C>
) -> Result<usize>

Performs a single step of this operation.

fn flush<C: WriteBuf + ?Sized>(
    &mut self,
    output: &mut OutBuffer<'_, C>
) -> Result<usize>

Flushes any internal buffer, if any.

fn finish<C: WriteBuf + ?Sized>(
    &mut self,
    output: &mut OutBuffer<'_, C>,
    _finished_frame: bool
) -> Result<usize>

Finishes the operation, writing any footer if necessary.

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

Prepares the operation for a new frame.

fn run_on_buffers(&mut self, input: &[u8], output: &mut [u8]) -> Result<Status>

Performs a single step of this operation.