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
27
28
29
30
31
32
33
34
35

use crate::long::LongEccHeader;

use super::super::OverlapFactor;

impl LongEccHeader {
    /// Returns the overlap factor: the approximate number of codewords covering each byte.
    #[inline]
    #[must_use]
    pub const fn overlap_factor(&self) -> OverlapFactor {
        OverlapFactor::from_u8(self.parity)
    }
}

#[cfg(test)]
mod tests {
    use crate::long::{LongEccHeader, OverlapFactor};

    type TestError = Box<dyn std::error::Error>;

    #[test]
    fn test_overlap_factor_roundtrips_through_header() -> Result<(), TestError> {
        for factor in [
            OverlapFactor::Simple,
            OverlapFactor::Double,
            OverlapFactor::Triple,
            OverlapFactor::Quadruple,
        ] {
            let header = LongEccHeader::new(2, factor, 86, 50, 0)?;

            assert_eq!(header.overlap_factor(), factor);
        }

        Ok(())
    }
}