Enum zstd::stream::raw::CParameter

source ·
pub enum CParameter {
Show 19 variants CompressionLevel(i32), WindowLog(u32), HashLog(u32), ChainLog(u32), SearchLog(u32), MinMatch(u32), TargetLength(u32), Strategy(ZSTD_strategy), EnableLongDistanceMatching(bool), LdmHashLog(u32), LdmMinMatch(u32), LdmBucketSizeLog(u32), LdmHashRateLog(u32), ContentSizeFlag(bool), ChecksumFlag(bool), DictIdFlag(bool), NbWorkers(u32), JobSize(u32), OverlapSizeLog(u32),
}
Expand description

A compression parameter.

Variants§

§

CompressionLevel(i32)

Compression level to use.

Compression levels are global presets for the other compression parameters.

§

WindowLog(u32)

Maximum allowed back-reference distance.

The actual distance is 2 power “this value”.

§

HashLog(u32)

§

ChainLog(u32)

§

SearchLog(u32)

§

MinMatch(u32)

§

TargetLength(u32)

§

Strategy(ZSTD_strategy)

§

EnableLongDistanceMatching(bool)

§

LdmHashLog(u32)

§

LdmMinMatch(u32)

§

LdmBucketSizeLog(u32)

§

LdmHashRateLog(u32)

§

ContentSizeFlag(bool)

§

ChecksumFlag(bool)

§

DictIdFlag(bool)

§

NbWorkers(u32)

How many threads will be spawned.

With a default value of 0, compress_stream* functions block until they complete.

With any other value (including 1, a single compressing thread), these methods directly return, and the actual compression is done in the background (until a flush is requested).

Note: this will only work if the zstdmt feature is activated.

§

JobSize(u32)

Size in bytes of a compression job.

Does not have any effect when NbWorkers is set to 0.

The default value of 0 finds the best job size based on the compression parameters.

Note: this will only work if the zstdmt feature is activated.

§

OverlapSizeLog(u32)

Specifies how much overlap must be given to each worker.

Possible values:

  • 0 (default value): automatic overlap based on compression strategy.
  • 1: No overlap
  • 1 < n < 9: Overlap a fraction of the window size, defined as 1/(2 ^ 9-n).
  • 9: Full overlap (as long as the window)
  • 9 < m: Will return an error.

Note: this will only work if the zstdmt feature is activated.

Trait Implementations§

source§

impl Clone for CParameter

source§

fn clone(&self) -> CParameter

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CParameter

source§

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

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

impl PartialEq<CParameter> for CParameter

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for CParameter

source§

impl Eq for CParameter

source§

impl StructuralEq for CParameter

source§

impl StructuralPartialEq for CParameter

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere T: Clone,

§

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 Twhere 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 Twhere 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.