Skip to main content

Dictionary

zrip_core::dict

Struct Dictionary 

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

A pre-trained zstd dictionary for improved compression of small data.

Load from raw bytes with Dictionary::from_bytes, or train with [train_dict_fastcover] (requires dict_builder feature).

Implementations§

Source§

impl Dictionary

Source

pub fn from_bytes(data: &[u8]) -> Result<Self, DecompressError>

Parses a dictionary from its raw byte representation.

Source

pub fn id(&self) -> u32

Returns the dictionary ID embedded in the header.

Source

pub fn content(&self) -> &[u8] ⓘ

Returns the raw content segment used as match-finding history prefix.

Source

pub fn rep_offsets(&self) -> &[u32; 3]

Returns the three initial repeat offsets stored in the dictionary.

Source

pub fn huf_table(&self) -> Option<(&[HuffmanDecodeEntry], u8)>

Source

pub fn of_table(&self) -> Option<(&[FseDecodeEntry], u8)>

Source

pub fn ml_table(&self) -> Option<(&[FseDecodeEntry], u8)>

Source

pub fn ll_table(&self) -> Option<(&[FseDecodeEntry], u8)>

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

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.