Skip to content

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

License

Notifications You must be signed in to change notification settings

PlayerData/reed-solomon-rs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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);
}

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 100.0%