Struct Fec 

pub struct Fec { /* private fields */ }

Forward Error Correcting encoder/decoder.

The encoder can be defined with 2 values: k and m

• k is the number of chunks needed to reconstruct the original message
• m is the total number of chunks that will be produced

The first k chunks contain the original unaltered data, meaning that if all the original chunks are available on the decoding end, no decoding needs to take place.

The final (m-k) chunks contain the parity coding necessary to reproduce any one of the original chunks.

Coding is done with respect to the chunk’s location within the encoded data. This means that each chunk’s sequence number is needed for correct reconstruction.

Example

use zfec_rs::Fec;

let message = b"Message to be sent";

let fec = Fec::new(5, 8).unwrap();

let (mut encoded_chunks, padding) = fec.encode(&message[..]).unwrap();
encoded_chunks.remove(2);
let decoded_message = fec.decode(&encoded_chunks, padding).unwrap();

assert_eq!(message.to_vec(), decoded_message);

Implementations

impl Fec

pub fn new(k: usize, m: usize) -> Result<Fec, Error>

Generates a new encoder/decoder

pub fn encode(&self, data: &[u8]) -> Result<(Vec<Chunk>, usize), Error>

Performs the encoding, returning the encoded chunks and the amount of padding

Because all chunks need to be the same size, the data is padded with 0s at the end as needed

pub fn decode( &self, encoded_data: &Vec<Chunk>, padding: usize, ) -> Result<Vec<u8>, Error>

Performs the decoding