Struct DDict 

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

A digested decompression dictionary.

Implementations

impl DDict<'static>

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

Prepare a dictionary to decompress data.

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

Panics

If loading this dictionary failed. See DDict::try_create.

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

Prepare a dictionary to decompress data.

The dictionary content will be copied internally, and does not need to be kept around. Returns None if zstd could not load the dictionary, for instance because it starts with the dictionary magic number but its header is corrupt.

impl<'a> DDict<'a>

pub fn sizeof(&self) -> usize

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

Available on crate feature experimental only.

Wraps the ZSTD_createDDict_byReference() function.

The dictionary will keep referencing dict_buffer.

Panics

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

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

Available on crate feature experimental only.

Wraps the ZSTD_createDDict_byReference() function.

The dictionary will keep 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 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 DDict<'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 DDict<'a>

impl<'a> Sync for DDict<'a>