Struct zstd::stream::raw::Encoder

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

An in-memory encoder for streams of data.

Implementations§

source§

impl Encoder<'static>

source

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

Creates a new encoder.

source

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

Creates a new encoder initialized with the given dictionary.

source§

impl<'a> Encoder<'a>

source

pub fn with_context(context: &'a mut CCtx<'static>) -> Self

Creates a new encoder that uses the provided context for serialization.

source

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

Creates a new encoder using an existing EncoderDictionary.

source

pub fn with_ref_prefix<'b>(level: i32, ref_prefix: &'b [u8]) -> Result<Self>
where 'b: 'a,

Creates a new encoder initialized with the given ref prefix.

source

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

Sets a compression parameter for this encoder.

source

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§

source§

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

source§

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

Performs a single step of this operation. Read more
source§

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

Flushes any internal buffer, if any. Read more
source§

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

Finishes the operation, writing any footer if necessary. Read more
source§

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

Prepares the operation for a new frame. Read more
source§

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

Performs a single step of this operation. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Encoder<'a>

§

impl<'a> RefUnwindSafe for Encoder<'a>

§

impl<'a> Send for Encoder<'a>

§

impl<'a> Sync for Encoder<'a>

§

impl<'a> Unpin for Encoder<'a>

§

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

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.