ps-ecc 0.1.0-9

Generates Reed-Solomon error correction codes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

use ps_buffer::Buffer;

use crate::{long, EncodeError, ReedSolomon};

/// Encodes a message by adding an error-correcting code.
///
/// Messages longer than `255 - 2 * parity` bytes are encoded in the long ECC
/// format; all other messages become a single Reed-Solomon codeword.
/// # Errors
/// For messages that fit a single codeword:
/// - `RSConstructorError` is returned if `parity` exceeds [`crate::MAX_PARITY`].
/// - `RSEncodeError` is returned if encoding fails.
///
/// For longer messages:
/// - `LongEccEncodeError` is returned if long encoding fails.
pub fn encode(message: &[u8], parity: u8) -> Result<Buffer, EncodeError> {
    if message.len() + (usize::from(parity) << 1) > 0xff {
        let codeword = long::encode(message, parity, long::OverlapFactor::Simple)?;

        return Ok(codeword);
    }

    let rs = ReedSolomon::new(parity)?;

    Ok(rs.encode(message)?)
}