Struct Encoder 

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

Reed-Solomon encoder using DefaultEngine and DefaultRate.

Implementations

impl Encoder

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

Adds one original shard to the encoder.

Original shards have indexes 0..original_count corresponding to the order in which they are added and these same indexes must be used when decoding.

See basic usage for an example.

pub fn encode(&mut self) -> Result<EncoderResult<'_>, Error>

Encodes the added original shards returning EncoderResult which contains the generated recovery shards.

When returned EncoderResult is dropped the encoder is automatically reset and ready for new round of encoding.

See basic usage for an example.

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

Creates new encoder 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 encoder to given configuration.

• Added original 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 commonware_cryptography::reed_solomon::Encoder;

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