Struct Decoder

Source
pub struct Decoder { /* private fields */ }
Expand description

Reed-Solomon BCH decoder

Implementations§

Source§

impl Decoder

Source

pub fn new(ecc_len: usize) -> Self

Constructs a new Decoder.

§Example
use reed_solomon::Decoder;

let decoder = Decoder::new(8);
Source

pub fn correct_err_count( &self, msg: &[u8], erase_pos: Option<&[u8]>, ) -> Result<(Buffer, usize), DecoderError>

Decodes block-encoded message and returns Buffer with corrected message and ecc offset. Also includes the number of errors corrected.

§Example
use reed_solomon::Encoder;
use reed_solomon::Decoder;

// Create encoder and decoder
let encoder = Encoder::new(4);
let decoder = Decoder::new(4);

// Encode message
let mut encoded = encoder.encode(&[1, 2, 3, 4]);

// Corrupt message
encoded[2] = 1;
encoded[3] = 2;

// Let's assume it's known that `encoded[3]` is an error
let known_erasures = [3];

// Decode and correct message,
let corrected = decoder.correct(&mut encoded, Some(&known_erasures)).unwrap();

// Check results
assert_eq!(&[1, 2, 3, 4], corrected.data())
Source

pub fn correct( &self, msg: &[u8], erase_pos: Option<&[u8]>, ) -> Result<Buffer, DecoderError>

Decodes block-encoded message and returns Buffer with corrected message and ecc offset.

§Example
use reed_solomon::Encoder;
use reed_solomon::Decoder;

// Create encoder and decoder
let encoder = Encoder::new(4);
let decoder = Decoder::new(4);

// Encode message
let mut encoded = encoder.encode(&[1, 2, 3, 4]);

// Corrupt message
encoded[2] = 1;
encoded[3] = 2;

// Let's assume it's known that `encoded[3]` is an error
let known_erasures = [3];

// Decode and correct message,
let corrected = decoder.correct(&mut encoded, Some(&known_erasures)).unwrap();

// Check results
assert_eq!(&[1, 2, 3, 4], corrected.data())
Source

pub fn is_corrupted(&self, msg: &[u8]) -> bool

Performs fast corruption check.

§Example
use reed_solomon::Encoder;
use reed_solomon::Decoder;

// Create encoder and decoder
let encoder = Encoder::new(4);
let decoder = Decoder::new(4);

// Encode message
let mut encoded = encoder.encode(&[1, 2, 3, 4]);

assert_eq!(decoder.is_corrupted(&encoded), false);

// Corrupt message
encoded[2] = 1;
encoded[3] = 2;

assert_eq!(decoder.is_corrupted(&encoded), true);

Trait Implementations§

Source§

impl Clone for Decoder

Source§

fn clone(&self) -> Decoder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Decoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for Decoder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.