Skip to main content

ZstdEncoder

Struct ZstdEncoder 

Source
pub struct ZstdEncoder { /* private fields */ }
Expand description

Zstandard encoder.

Supports multiple compression levels (0-22) with LZ77 matching, Huffman literal encoding, and FSE sequence encoding.

Implementations§

Source§

impl ZstdEncoder

Source

pub fn new() -> Self

Create a new encoder with default settings (level 0, RLE strategy).

Source

pub fn set_checksum(&mut self, include: bool) -> &mut Self

Set whether to include content checksum.

Source

pub fn set_content_size(&mut self, include: bool) -> &mut Self

Set whether to include content size in header.

Source

pub fn set_strategy(&mut self, strategy: CompressionStrategy) -> &mut Self

Set compression strategy (only effective when level == 0).

Source

pub fn set_level(&mut self, level: i32) -> &mut Self

Set compression level (0-22).

  • Level 0: Raw/RLE blocks (fastest, no compression)
  • Levels 1-3: Fast compression (greedy matching)
  • Levels 4-9: Balanced compression (lazy matching)
  • Levels 10-22: High compression (deep search)
Source

pub fn set_dictionary(&mut self, dict: &[u8]) -> &mut Self

Set a pre-trained dictionary for improved compression of small data.

Source

pub fn compress(&self, data: &[u8]) -> Result<Vec<u8>>

Compress data into a Zstandard frame.

Uses the configured compression level and strategy.

Trait Implementations§

Source§

impl Clone for ZstdEncoder

Source§

fn clone(&self) -> ZstdEncoder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ZstdEncoder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ZstdEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.