ps-ecc 0.1.0-8

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

#![allow(clippy::module_name_repetitions)]

use std::{array::TryFromSliceError, num::TryFromIntError};

use ps_buffer::BufferError;
use thiserror::Error;

#[derive(Error, Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum GFError {
    #[error("Division by zero is undefined.")]
    DivByZero,
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum PolynomialError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    GFError(#[from] GFError),
    #[error("Divisor cannot be zero.")]
    ZeroDivisor,
}

#[derive(Error, Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum RSConstructorError {
    #[error("Parity count must be <= 127.")]
    ParityTooHigh,
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSGenerateParityError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    PolynomialError(#[from] PolynomialError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSEncodeError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    RSGenerateParityError(#[from] RSGenerateParityError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSValidationError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSEuclideanError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    PolynomialError(#[from] PolynomialError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSComputeErrorsError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    GFError(#[from] GFError),
    #[error(transparent)]
    RSEuclideanError(#[from] RSEuclideanError),
    #[error("Too many errors, input in unrecoverable.")]
    TooManyErrors,
    #[error("The error locator derivative evaluated to zero.")]
    ZeroErrorLocatorDerivative,
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum RSDecodeError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error(transparent)]
    RSComputeErrorsError(#[from] RSComputeErrorsError),
    #[error(transparent)]
    RSConstructorError(#[from] RSConstructorError),
    #[error(transparent)]
    RSValidationError(#[from] RSValidationError),
    #[error("Too many errors to correct. Error computation nevertheless returned a valid polynomial, which is unlikely. Usually you'll get RSComputeErrorsError(TooManyErrors) instead.")]
    TooManyErrors,
    #[error(transparent)]
    TryFromIntError(#[from] TryFromIntError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum EncodeError {
    #[error(transparent)]
    LongEccEncodeError(#[from] LongEccEncodeError),
    #[error(transparent)]
    RSConstructorError(#[from] RSConstructorError),
    #[error(transparent)]
    RSEncodeError(#[from] RSEncodeError),
}

#[derive(Error, Debug, Clone)]
pub enum DecodeError {
    #[error("Insufficient input bytes for parity count of {0}: {0} * 2 > {1}.")]
    InsufficientParityBytes(u8, u8),
    #[error(transparent)]
    LongEccDecodeError(#[from] LongEccDecodeError),
    #[error(transparent)]
    RSConstructorError(#[from] RSConstructorError),
    #[error(transparent)]
    RSDecodeError(#[from] RSDecodeError),
}
#[derive(Error, Debug, Clone)]
pub enum EccError {
    #[error(transparent)]
    EncodeError(#[from] EncodeError),
    #[error(transparent)]
    DecodeError(#[from] DecodeError),
}

#[derive(Error, Debug, Clone)]
pub enum LongEccConstructorError {
    #[error("Received {0} header bytes, {0} < 16.")]
    InsufficientHeaderBytes(u8),
    #[error(transparent)]
    RSDecodeError(#[from] RSDecodeError),
    #[error(transparent)]
    TryFromIntError(#[from] TryFromIntError),
    #[error(transparent)]
    TryFromSliceError(#[from] TryFromSliceError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum LongEccToBytesError {
    #[error(transparent)]
    RSConstructorError(#[from] RSConstructorError),
    #[error(transparent)]
    RSGenerateParityError(#[from] RSGenerateParityError),
}

#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum LongEccEncodeError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error("Parity {0} >= 64, which is too high.")]
    InvalidParity(u8),
    #[error("Invalid segment-to-parity ratio: {0} < 2 * {1}")]
    InvalidSegmentParityRatio(u8, u8),
    #[error(transparent)]
    LongEccToBytesError(#[from] LongEccToBytesError),
    #[error(transparent)]
    RSConstructorError(#[from] RSConstructorError),
    #[error(transparent)]
    RSGenerateParityError(#[from] RSGenerateParityError),
    #[error(transparent)]
    TryFromIntError(#[from] TryFromIntError),
}

#[derive(Error, Debug, Clone)]
pub enum LongEccDecodeError {
    #[error(transparent)]
    BufferError(#[from] BufferError),
    #[error("Codeword is invalid.")]
    InvalidCodeword,
    #[error(transparent)]
    LongEccConstructorError(#[from] LongEccConstructorError),
    #[error("Failed to read data bytes.")]
    ReadDataError,
    #[error("Failed to read parity bytes.")]
    ReadParityError,
    #[error(transparent)]
    RSDecodeError(#[from] RSDecodeError),
    #[error(transparent)]
    TryFromIntError(#[from] TryFromIntError),
}