Struct zstd::stream::raw::Encoder

[+] Show declaration

pub struct Encoder { /* fields omitted */ }

[−] Expand description

An in-memory encoder for streams of data.

Implementations

impl Encoder[−]

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.

pub fn with_prepared_dictionary(
    dictionary: &EncoderDictionary<'_>
) -> Result<Self>[−]

Creates a new encoder using an existing EncoderDictionary.

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

Sets a compression parameter for this encoder.

Trait Implementations

impl Operation for Encoder[+]

[+] Show hidden undocumented items

fn run(
    &mut self,
    input: &mut InBuffer<'_>,
    output: &mut OutBuffer<'_>
) -> Result<usize>[−]

Performs a single step of this operation.

fn flush(&mut self, output: &mut OutBuffer<'_>) -> Result<usize>[−]

Flushes any internal buffer, if any.

fn finish(
    &mut self,
    output: &mut OutBuffer<'_>,
    _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.