Struct ReedSolomon 

pub struct ReedSolomon { /* private fields */ }

A systematic Reed-Solomon erasure code with k data shards and m = n − k parity shards. Cheap to clone (holds only the n×k generator matrix); construct once with ReedSolomon::new and reuse across many messages of the same shape.

Implementations

impl ReedSolomon

pub fn new(data_shards: usize, parity_shards: usize) -> Option<Self>

Build a code with data_shards data shards and parity_shards parity shards. Returns None if the parameters are out of range: both counts must be at least one and the total n = data + parity must fit the field’s distinct nodes (n ≤ 256). The construction is deterministic — same parameters, same code.

pub fn data_shards(&self) -> usize

The number of data shards k.

pub fn parity_shards(&self) -> usize

The number of parity shards m = n − k.

pub fn total_shards(&self) -> usize

The total number of shards n = k + m.

pub fn encode(&self, data: &[Vec<u8>]) -> Option<Vec<Vec<u8>>>

Encode k equal-length data shards into n shards. The first k outputs are the data shards unchanged (the code is systematic); the remaining m are parity. Returns None unless exactly k shards of equal length are supplied.

pub fn reconstruct(&self, shards: &[Option<Vec<u8>>]) -> Option<Vec<Vec<u8>>>

Reconstruct all n shards from a slice of n slots, each Some(shard) if the shard survived or None if it was erased. Succeeds when at least k shards survive (and share a length); returns None otherwise. The result is the full, byte-exact set of n shards — recovered data in 0..k, regenerated parity after.

Trait Implementations

impl Clone for ReedSolomon

fn clone(&self) -> ReedSolomon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReedSolomon

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

Formats the value using the given formatter.