Struct CDict 

pub struct CDict<'a>(/* private fields */);

Compression dictionary.

With with-rust-allocator, prepared dictionaries retain fixed compression parameters rather than adapting them to later input sizes. This can change compression ratio, speed, and memory usage compared with the C allocator.

Implementations

impl CDict<'static>

pub fn create(dict_buffer: &[u8], compression_level: CompressionLevel) -> Self

Prepare a dictionary to compress data.

This will make it easier for compression contexts to load this dictionary.

The dictionary content will be copied internally, and does not need to be kept around.

Panics

If loading this dictionary failed.

pub fn try_create( dict_buffer: &[u8], compression_level: CompressionLevel, ) -> Option<Self>

Prepare a dictionary to compress data.

This will make it easier for compression contexts to load this dictionary.

The dictionary content will be copied internally, and does not need to be kept around.

impl<'a> CDict<'a>

pub fn create_by_reference( dict_buffer: &'a [u8], compression_level: CompressionLevel, ) -> Self

Available on crate feature experimental only.

Prepare a dictionary to compress data, referencing dict_buffer.

Panics

If loading this dictionary failed. See CDict::try_create_by_reference.

pub fn try_create_by_reference( dict_buffer: &'a [u8], compression_level: CompressionLevel, ) -> Option<Self>

Available on crate feature experimental only.

Prepare a dictionary to compress data, referencing dict_buffer.

Returns None if zstd could not load the dictionary, for instance because it starts with the dictionary magic number but its header is corrupt.

pub fn sizeof(&self) -> usize

Returns the current memory usage of this dictionary.

Note that this may change over time.

pub fn get_dict_id(&self) -> Option<NonZeroU32>

Returns the dictionary ID for this dict.

Returns None if this dictionary is empty or invalid.

Trait Implementations

impl<'a> Drop for CDict<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a> Send for CDict<'a>

impl<'a> Sync for CDict<'a>