Struct CodecOptions 

#[non_exhaustive]
pub struct CodecOptions {
    pub fast_one_parity: bool,
    pub inversion_cache: bool,
    pub inversion_cache_capacity: usize,
    pub codec_family: CodecFamily,
    pub leopard_mode: LeopardMode,
    pub matrix_mode: MatrixMode,
    pub max_parallel_jobs: usize,
}

Configuration options for constructing a ReedSolomon codec.

Use CodecOptions::default() for sensible defaults, or the builder methods:

use rustfs_erasure_codec::core::{CodecOptions, CodecFamily};

let opts = CodecOptions::builder()
    .codec_family(CodecFamily::LeopardGF8)
    .fast_one_parity(true)
    .build();

CodecOptions is #[non_exhaustive]: construct it from CodecOptions::default() (optionally with ..Default::default() in a struct-update expression) or via the builder, not with an exhaustive struct literal. This lets future fields be added without a breaking change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fast_one_parity: bool

When true and parity shard count is 1, use XOR-only fast path instead of full matrix multiplication. Default: false.

inversion_cache: bool

When true, cache the inverted decode matrix for repeated reconstruction with the same erasure pattern. Default: true.

inversion_cache_capacity: usize

Capacity of the inversion cache (LRU). 0 means automatic sizing based on shard counts. Default: 0.

codec_family: CodecFamily

The codec algorithm family to use. Default: CodecFamily::Classic.

leopard_mode: LeopardMode

Optional automatic Leopard selection when codec_family is CodecFamily::Classic. Default: LeopardMode::Disabled (no auto-selection; behaviour identical to prior releases). See LeopardMode.

matrix_mode: MatrixMode

The matrix construction strategy (only used for CodecFamily::Classic). Default: MatrixMode::Vandermonde.

max_parallel_jobs: usize

Maximum number of parallel jobs for encode/decode operations. 0 means automatic (uses available_parallelism()). Default: 0.

Implementations

impl CodecOptions

pub fn builder() -> CodecOptionsBuilder

Create a new builder with default options.

Trait Implementations

impl Clone for CodecOptions

fn clone(&self) -> CodecOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CodecOptions

impl Debug for CodecOptions

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

Formats the value using the given formatter.

impl Default for CodecOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CodecOptions

impl PartialEq for CodecOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodecOptions