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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use crate::long::LongEccHeader;

impl LongEccHeader {
    /// Returns the error-correction capability per segment: the number of byte errors each segment can recover from.
    #[inline]
    #[must_use]
    pub const fn parity(&self) -> u8 {
        self.parity & 0x3F
    }
}

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

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

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

            assert_eq!(header.parity(), 5);
        }

        Ok(())
    }

    #[test]
    fn test_parity_zero() -> Result<(), TestError> {
        let header = LongEccHeader::new(0, OverlapFactor::Simple, 82, 50, 0)?;

        assert_eq!(header.parity(), 0);

        Ok(())
    }

    #[test]
    fn test_parity_maximum() -> Result<(), TestError> {
        let header = LongEccHeader::new(MAX_PARITY, OverlapFactor::Simple, 208, 50, 0)?;

        assert_eq!(header.parity(), MAX_PARITY);

        Ok(())
    }
}