Module reed_solomon 

Vendored version of reed_solomon_simd.

Changes vs. Upstream

• Moved the crate into commonware_cryptography::reed_solomon and rewrote internal crate:: paths accordingly.
• Retained the upstream LICENSE file, including the BSD-3-Clause notice for Leopard-RS.
• Removed the build script and README rustdoc generation.
• Removed upstream examples. Kept upstream-style benchmarks under Commonware’s benchmark layout and naming rules.
• Uses workspace dependencies and commonware_formatting in the test harness.
• Uses thiserror for error display formatting.
• Renamed upstream ReedSolomonEncoder and ReedSolomonDecoder to Encoder and Decoder.
• Uses plain code references for cfg-gated SIMD engine docs so rustdoc works on all targets.

Re-exports

pub use self::engine::SHARD_CHUNK_BYTES;

Modules

algorithm

Algorithm documentation.

engine

Low-level building blocks for Reed-Solomon encoding/decoding.

rate

Advanced encoding/decoding using chosen Engine and Rate.

Structs

Decoder

Reed-Solomon decoder using DefaultEngine and DefaultRate.

DecoderResult

The restored original shards from a decode that ran (an original was missing).

Encoder

Reed-Solomon encoder using DefaultEngine and DefaultRate.

EncoderResult

Result of encoding. Contains the generated recovery shards.

Originals

Iterator over restored original shards and their indexes.

Recoveries

Iterator over restored recovery shards and their indexes.

Recovery

Iterator over generated recovery shards.

RecoveryDecoderResult

The restored shards from a successful Decoder::decode_with_recovery, exposing both the restored original shards (like DecoderResult) and the reconstructed recovery shards.

Enums

Error

Represents all possible errors that can occur in this library.