Struct zstd_safe::CDict

source ·
pub struct CDict<'a>(/* private fields */);
Expand description

Compression dictionary.

Implementations§

source§

impl CDict<'static>

source

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.

source

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.

source§

impl<'a> CDict<'a>

source

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

Available on crate feature experimental only.
source

pub fn sizeof(&self) -> usize

Returns the current memory usage of this dictionary.

Note that this may change over time.

source

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§

source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for CDict<'a>

§

impl<'a> RefUnwindSafe for CDict<'a>

§

impl<'a> Unpin for CDict<'a>

§

impl<'a> UnwindSafe for CDict<'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.