Skip to main content

CompressionConfig

Struct CompressionConfig 

Source
pub struct CompressionConfig {
    pub level: i32,
    pub window_log: u32,
    pub checksum: bool,
    pub content_size: bool,
    pub dict_id: bool,
    pub format: FrameFormat,
}
Expand description

Every compression setting, stated explicitly by the caller. Use one of the named presets or build your own; there is no implicit default.

Fields§

§level: i32

zstd level: MIN_LEVEL..=MAX_LEVEL, excluding 0. Levels mean what they mean in zstd.

§window_log: u32

Upper bound on the window (log2 bytes, 10..=30). The window also shrinks to fit the input.

§checksum: bool

Append the XXH64-based content checksum.

§content_size: bool

Record the content size in the frame header.

§dict_id: bool

Record the dictionary ID in the frame header (when the dictionary has one).

§format: FrameFormat

Standard frames, or magicless ones (4 bytes smaller; the decoder must be told).

Implementations§

Source§

impl CompressionConfig

Source

pub const FAST: CompressionConfig

zstd level 1: fastest.

Source

pub const DEFAULT: CompressionConfig

zstd level 3: the reference default.

Source

pub const HIGH: CompressionConfig

zstd level 19: optimal parsing.

Source

pub const MESSAGE: CompressionConfig

Small-message profile: level 3, no dictionary ID (the ID is known out of band).

Source

pub fn validate(&self) -> Result<()>

Checks every field’s range.

Trait Implementations§

Source§

impl Clone for CompressionConfig

Source§

fn clone(&self) -> Self

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 CompressionConfig

Source§

impl Debug for CompressionConfig

Source§

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

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

impl Eq for CompressionConfig

Source§

impl PartialEq for CompressionConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CompressionConfig

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.