Struct ReedSolomon

pub struct ReedSolomon { /* private fields */ }

Implementations

impl ReedSolomon

pub const fn new(parity: u8) -> Result<Self, RSConstructorError>

Creates a new Reed-Solomon codec with parameters n and k.

Errors

• ParityTooHigh is returned if parity > 127

pub const fn parity(&self) -> u8

pub const fn parity_bytes(&self) -> u8

pub fn generate_parity( &self, message: &[u8], ) -> Result<Buffer, RSGenerateParityError>

Generates parity bytes.

Errors

• BufferError if an allocation fails
• PolynomialError if generator polynomial is zero (shouldn’t happen)

pub fn encode(&self, message: &[u8]) -> Result<Buffer, RSEncodeError>

Encodes a message into a codeword.

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• PolynomialError if generator polynomial is zero (shouldn’t happen)

pub fn compute_syndromes( num_parity_bytes: impl Into<usize>, received: &[u8], ) -> Result<Buffer, BufferError>

Computes the syndromes of a given codeword.

Errors

• BufferError if allocation fails

pub fn compute_syndromes_detached( parity: &[u8], data: &[u8], ) -> Result<Buffer, BufferError>

Computes the syndromes of a given detached codeword.

Errors

• BufferError if allocation fails

pub fn validate( &self, received: &[u8], ) -> Result<Option<Buffer>, RSValidationError>

Validates a received codeword.

Errors

Err(syndromes) is returned if the codeword is invalid.

pub fn validate_detached( parity: &[u8], data: &[u8], ) -> Result<Option<Buffer>, RSValidationError>

Validates a regregated (parity, message) pair.

Errors

Err(syndromes) is returned if the codeword is invalid.

pub fn compute_errors( &self, length: usize, syndromes: &[u8], ) -> Result<Option<Buffer>, RSComputeErrorsError>

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• RSDecodeError::TooManyErrors is returned if the input is unrecoverable.

pub fn correct<'lt>( &self, received: &'lt [u8], ) -> Result<Cow<'lt>, RSDecodeError>

Corrects a received codeword, returning the corrected codeword.

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• RSDecodeError is propagated from ReedSolomon::compute_errors.

pub fn correct_in_place(&self, received: &mut [u8]) -> Result<(), RSDecodeError>

Corrects a received codeword in-place.

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• RSDecodeError is propagated from ReedSolomon::compute_errors.
• RSDecodeError::TooManyErrors is returned if the data is unrecoverable.

pub fn decode<'lt>( &self, received: &'lt [u8], ) -> Result<Codeword<'lt>, RSDecodeError>

Decodes a received codeword, correcting errors if possible.

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• RSDecodeError is propagated from ReedSolomon::compute_errors.

pub fn correct_detached<'lt>( parity: &[u8], data: &'lt [u8], ) -> Result<Codeword<'lt>, RSDecodeError>

Corrects a message based on detached parity bytes.

Errors

• ps_buffer::BufferError is returned if memory allocation fails.
• RSDecodeError is propagated from ReedSolomon::compute_errors.

pub fn correct_detached_data_in_place( parity: &[u8], data: &mut [u8], ) -> Result<(), RSDecodeError>

Corrects a message based on detached parity bytes.

Errors

• RSDecodeError is returned if data is not recoverable.

pub fn correct_detached_in_place( parity: &mut [u8], data: &mut [u8], ) -> Result<(), RSDecodeError>

Corrects a message based on detached parity bytes. Also corrects the parity bytes.

Errors

• RSDecodeError is propagated from ReedSolomon::compute_errors.

pub fn apply_corrections(target: &mut [u8], corrections: impl AsRef<[u8]>)

pub fn apply_corrections_detached( parity: &mut [u8], data: &mut [u8], corrections: impl AsRef<[u8]>, )