Struct CorrectionResult 

#[non_exhaustive]
pub struct CorrectionResult {
    pub data: Vec<u8>,
    pub corrections_applied: usize,
    pub corrected_positions: Vec<usize>,
}

Result of a successful BCH decode + correct attempt.

Returned by bch_correct_regular / bch_correct_long when correction succeeds. corrections_applied == 0 means the input was already valid; > 0 means substitutions were applied at the indicated positions.

Marked #[non_exhaustive] to allow future fields (e.g., confidence score, syndrome metadata) without breaking downstream struct-literal construction. Construct via the bch_correct_regular / bch_correct_long APIs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data: Vec<u8>

The corrected data_with_checksum slice (input may have been modified).

corrections_applied: usize

Number of substitutions applied (0 = clean input).

corrected_positions: Vec<usize>

Indices into data of the substituted positions.

Trait Implementations

impl Clone for CorrectionResult

fn clone(&self) -> CorrectionResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CorrectionResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CorrectionResult

fn eq(&self, other: &CorrectionResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CorrectionResult

impl StructuralPartialEq for CorrectionResult