Struct ErasureCoding 

pub struct ErasureCoding;

Erasure coding abstraction.

Supports creation of parity shards and recovery of missing data.

Implementations

impl ErasureCoding

pub fn new() -> Self

Create new erasure coding instance

pub fn extend<const NUM_SHARDS: usize, const SHARD_BYTES: usize>( &self, source: &[[u8; SHARD_BYTES]; NUM_SHARDS], parity: &mut [[u8; SHARD_BYTES]; NUM_SHARDS], ) -> Result<(), ErasureCodingError>

Extend contiguously stored source shards with parity shards

pub fn extend_scattered<const NUM_SHARDS: usize, const SHARD_BYTES: usize, SourceShard, ParityShard>( &self, source: [SourceShard; NUM_SHARDS], parity: [ParityShard; NUM_SHARDS], ) -> Result<(), ErasureCodingError>

where SourceShard: AsRef<[u8; SHARD_BYTES]>, ParityShard: AsMut<[u8; SHARD_BYTES]>,

Extend source shards with parity shards, where shards are not stored contiguously

pub fn recover_source<const NUM_SHARDS: usize, const SHARD_BYTES: usize>( &self, source: &mut [[u8; SHARD_BYTES]; NUM_SHARDS], parity: &[[u8; SHARD_BYTES]; NUM_SHARDS], present: &ShardsPresent<NUM_SHARDS>, ) -> Result<(), ErasureCodingError>

Recover missing source shards in place, with everything stored contiguously.

Parity shards are inputs only, missing ones are simply not used. Prefer this over Self::recover_all() when parity shards are not needed.

pub fn recover_source_scattered<const NUM_SHARDS: usize, const SHARD_BYTES: usize, SourceShard, ParityShard>( &self, source: [SourceShard; NUM_SHARDS], source_present: &ShardsBitmap<NUM_SHARDS>, parity: [Option<ParityShard>; NUM_SHARDS], ) -> Result<(), ErasureCodingError>

where SourceShard: AsMut<[u8; SHARD_BYTES]>, ParityShard: AsRef<[u8; SHARD_BYTES]>,

Recover missing source shards in place, where shards are not stored contiguously.

Parity shards are inputs only, so missing ones simply have no memory.

pub fn recover_all<const NUM_SHARDS: usize, const SHARD_BYTES: usize>( &self, source: &mut [[u8; SHARD_BYTES]; NUM_SHARDS], parity: &mut [[u8; SHARD_BYTES]; NUM_SHARDS], present: &ShardsPresent<NUM_SHARDS>, ) -> Result<(), ErasureCodingError>

Recover missing source and parity shards in place, with everything stored contiguously.

Use Self::recover_source() instead if parity shards are not needed.

pub fn recover_all_scattered<const NUM_SHARDS: usize, const SHARD_BYTES: usize, SourceShard, ParityShard>( &self, source: [SourceShard; NUM_SHARDS], parity: [ParityShard; NUM_SHARDS], present: &ShardsPresent<NUM_SHARDS>, ) -> Result<(), ErasureCodingError>

where SourceShard: AsMut<[u8; SHARD_BYTES]>, ParityShard: AsMut<[u8; SHARD_BYTES]>,

Recover missing source and parity shards in place, where shards are not stored contiguously

Trait Implementations

impl Clone for ErasureCoding

fn clone(&self) -> ErasureCoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErasureCoding

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

Formats the value using the given formatter.

impl Default for ErasureCoding

fn default() -> Self

Returns the “default value” for a type.