Skip to main content

CParameter

Enum CParameter 

Source
#[non_exhaustive]
pub enum CParameter { WindowLog, HashLog, ChainLog, SearchLog, MinMatch, TargetLength, Strategy, EnableLongDistanceMatching, LdmHashLog, LdmMinMatch, LdmBucketSizeLog, LdmHashRateLog, }
Expand description

One tunable compression parameter — the analogue of a C zstd ZSTD_cParameter. Used to query bounds via CParameter::bounds.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

WindowLog

Maximum back-reference distance, log2. C ZSTD_c_windowLog.

§

HashLog

Match-finder hash table size, log2. C ZSTD_c_hashLog.

§

ChainLog

Match-finder chain table size, log2. C ZSTD_c_chainLog.

§

SearchLog

Number of search attempts, log2. C ZSTD_c_searchLog.

§

MinMatch

Minimum match length in bytes. C ZSTD_c_minMatch.

§

TargetLength

“Good enough” match length that ends the search. C ZSTD_c_targetLength.

§

Strategy

Match-finder Strategy (1..=9). C ZSTD_c_strategy.

§

EnableLongDistanceMatching

LDM enable flag (0/1). C ZSTD_c_enableLongDistanceMatching.

§

LdmHashLog

LDM hash table size, log2. C ZSTD_c_ldmHashLog.

§

LdmMinMatch

LDM minimum match length in bytes. C ZSTD_c_ldmMinMatch.

§

LdmBucketSizeLog

LDM bucket size, log2. C ZSTD_c_ldmBucketSizeLog.

§

LdmHashRateLog

LDM hash-insertion rate, log2. C ZSTD_c_ldmHashRateLog.

Implementations§

Source§

impl CParameter

Source

pub const fn bounds(self) -> Bounds

Inclusive value bounds for this parameter, mirroring ZSTD_cParam_getBounds. Window/hash/chain logs cap at 30 (the encoder’s match-finder ceiling) rather than the 31 C allows on 64-bit, because the back-reference history is indexed with u32 positions over a 2 * window eviction band.

Trait Implementations§

Source§

impl Clone for CParameter

Source§

fn clone(&self) -> CParameter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CParameter

Source§

impl Debug for CParameter

Source§

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

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

impl Eq for CParameter

Source§

impl PartialEq for CParameter

Source§

fn eq(&self, other: &CParameter) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CParameter

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.