Skip to main content

CodecTunables

Struct CodecTunables 

Source
pub struct CodecTunables {
    pub quality: u8,
    pub zstd_quality: u8,
    pub xz_level: u8,
    pub ppmd_order: u8,
    pub ppmd7_budget: usize,
    pub ppmd8_budget: usize,
    pub bzip2_block_kb: u32,
    pub lzma_dict_mb: u32,
}
Expand description

Codec-agnostic tunables. Every codec reads only the fields it understands; the rest are ignored. The struct is the single source of truth for “what knobs does the writer want to turn” — adding a new knob is one field here, not a new compress_with_* function per codec (OCP).

Fields§

§quality: u8

Brotli quality (0..=11). Codecs without a quality parameter ignore this. Historically this also served as a ZSTD level proxy — decoupled below since the two scales diverged (omnizip 0.21.12+ runs the optimal parser at every zstd level >= L3, so brotli’s default q11 was silently pushing zstd into the slow band).

§zstd_quality: u8

ZSTD quality (0..=22 via level_for_quality). 0 = fast-tier default. Independent of quality (brotli) by design.

§xz_level: u8

XZ preset (0..=9). 0 = preset 6 (xz’s balanced default). Independent of quality (brotli) — see zstd_quality.

§ppmd_order: u8

PPMd7 / PPMd8 context-model order (1..=16).

§ppmd7_budget: usize

PPMd7 context-tree memory budget in bytes. 0 = codec default.

§ppmd8_budget: usize

PPMd8 context-tree memory budget in bytes. 0 = codec default.

§bzip2_block_kb: u32

BZip2 block size in KB (100..=900). Maps to level 1..=9.

§lzma_dict_mb: u32

LZMA dictionary size in MB. Reserved — no pure-Rust LZMA encoder exists yet; field is here so profiles can declare intent and we wire it when omnizip-lzma ships an encoder.

Implementations§

Source§

impl CodecTunables

Source

pub fn from_quality(quality: u8) -> Self

Build tunables carrying only quality. Codecs that don’t override compress_with_tunables see no difference from compress(plaintext).

Trait Implementations§

Source§

impl Clone for CodecTunables

Source§

fn clone(&self) -> CodecTunables

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 Debug for CodecTunables

Source§

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

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

impl Default for CodecTunables

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, <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.