Struct reed_solomon_novelpoly::CodeParams

pub struct CodeParams { /* private fields */ }

Params for the encoder / decoder derived from a target validator count.

Implementations

impl CodeParams

pub fn derive_parameters(n: usize, k: usize) -> Result<Self>

Create a new reed solomon erasure encoding wrapper k the intended number of data shards needed to recover. n the intended number of resulting shards.

Assures that the derived paramters retain at most the given coding rate, and as such assure recoverability with at least an equiv fraction as provided by the input n, and k parameterset.

pub fn is_faster8(&self) -> bool

Check if this could use the faster8 code path, possibly utilizing avx SIMD instructions

pub fn make_encoder(&self) -> ReedSolomon

pub fn n(&self) -> usize

Return the computed n value.

pub fn k(&self) -> usize

Return the computed k value.

Trait Implementations

impl Clone for CodeParams

fn clone(&self) -> CodeParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeParams

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

Formats the value using the given formatter.

impl PartialEq for CodeParams

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

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

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.

impl Copy for CodeParams

impl Eq for CodeParams

impl StructuralEq for CodeParams

impl StructuralPartialEq for CodeParams