Struct ReedSolomonDecoder

pub struct ReedSolomonDecoder(/* private fields */);

Reed-Solomon decoder using DefaultEngine and DefaultRate.

Implementations

impl ReedSolomonDecoder

pub fn add_original_shard<T: AsRef<[u8]>>( &mut self, index: usize, original_shard: T, ) -> Result<(), Error>

Adds one original shard to the decoder.

• Shards can be added in any order.
• Index must be the same that was used in encoding.

See basic usage for an example.

pub fn add_recovery_shard<T: AsRef<[u8]>>( &mut self, index: usize, recovery_shard: T, ) -> Result<(), Error>

Adds one recovery shard to the decoder.

• Shards can be added in any order.
• Index must be the same that was used in encoding.

See basic usage for an example.

pub fn decode(&mut self) -> Result<DecoderResult<'_>, Error>

Decodes the added shards returning DecoderResult which contains the restored original shards.

When returned DecoderResult is dropped the decoder is automatically reset and ready for new round of decoding.

See basic usage for an example.

pub fn new( original_count: usize, recovery_count: usize, shard_bytes: usize, ) -> Result<Self, Error>

Creates new decoder with given configuration and allocates required working space.

See basic usage for an example.

pub fn reset( &mut self, original_count: usize, recovery_count: usize, shard_bytes: usize, ) -> Result<(), Error>

Resets decoder to given configuration.

• Added shards are forgotten.
• Existing working space is re-used if it’s large enough or re-allocated otherwise.

pub fn supports(original_count: usize, recovery_count: usize) -> bool

Returns true if given original_count / recovery_count combination is supported.

Examples

use reed_solomon_simd::ReedSolomonDecoder;

assert_eq!(ReedSolomonDecoder::supports(60_000, 4_000), true);
assert_eq!(ReedSolomonDecoder::supports(60_000, 5_000), false);