#codec #bch #ecc

no-std reed-solomon

Reed-Solomon BCH encoder and decoder with support of no_std environment

8 releases

Uses old Rust 2015

0.2.1 Jan 20, 2018
0.2.0 Sep 2, 2017
0.1.6 Oct 17, 2016

#803 in Cryptography

Download history 181/week @ 2024-06-13 199/week @ 2024-06-20 143/week @ 2024-06-27 92/week @ 2024-07-04 165/week @ 2024-07-11 203/week @ 2024-07-18 201/week @ 2024-07-25 209/week @ 2024-08-01 227/week @ 2024-08-08 201/week @ 2024-08-15 193/week @ 2024-08-22 222/week @ 2024-08-29 194/week @ 2024-09-05 192/week @ 2024-09-12 211/week @ 2024-09-19 167/week @ 2024-09-26

802 downloads per month
Used in 38 crates (8 directly)

MIT license

51KB
985 lines

Reed-Solomon BCH

license Build Status Crates.io Documentation

Reed-Solomon BCH encoder and decoder implemented in Rust. This is a port of python implementation from Wikiversity

Setup

[dependencies]
reed-solomon = "0.2"
extern crate reed_solomon

Example

extern crate reed_solomon;

use reed_solomon::Encoder;
use reed_solomon::Decoder;

fn main() {
    let data = b"Hello World!";

    // Length of error correction code
    let ecc_len = 8;

    // Create encoder and decoder with 
    let enc = Encoder::new(ecc_len);
    let dec = Decoder::new(ecc_len);

    // Encode data
    let encoded = enc.encode(&data[..]);

    // Simulate some transmission errors
    let mut corrupted = *encoded;
    for i in 0..4 {
        corrupted[i] = 0x0;
    }

    // Try to recover data
    let known_erasures = [0];
    let recovered = dec.correct(&mut corrupted, Some(&known_erasures)).unwrap();

    let orig_str = std::str::from_utf8(data).unwrap();
    let recv_str = std::str::from_utf8(recovered.data()).unwrap();

    println!("message:               {:?}", orig_str);
    println!("original data:         {:?}", data);
    println!("error correction code: {:?}", encoded.ecc());
    println!("corrupted:             {:?}", corrupted);
    println!("repaired:              {:?}", recv_str);
}

No runtime deps