Struct DecodedMultiframe 

pub struct DecodedMultiframe {
    pub data: Vec<u8>,
    pub data_bits: usize,
    pub frames_consumed: usize,
    pub corrupted_frames: usize,
    pub fill_frames: usize,
    pub corrected_frames: usize,
    pub uncorrectable_frames: usize,
}

Outcome of decode_multiframe and decode_multiframe_with_correction.

Fields

data: Vec<u8>

The recovered inner coded video bitstream, MSB-first packed.

data_bits: usize

Number of bits in data (a multiple of 492 when input is whole frames; the caller can trim further if it knows the inner-stream byte boundary).

frames_consumed: usize

Number of FEC frames consumed.

corrupted_frames: usize

Number of frames whose 18-bit syndrome was non-zero (i.e. at least one bit error was detected). Surfaced to the caller for diagnostics; the data from those frames is included in data regardless. With decode_multiframe this is the only error signal; with decode_multiframe_with_correction the breakdown is reported via corrected_frames + uncorrectable_frames.

fill_frames: usize

Number of fill-only frames skipped (Fi=0 / inner data all ones).

corrected_frames: usize

Number of frames whose single-bit error was successfully located and flipped by locate_single_error before the data was emitted. Always 0 for decode_multiframe (which never corrects). A subset of corrupted_frames.

uncorrectable_frames: usize

Number of frames with a non-zero syndrome that could not be resolved as a single-bit error (i.e. weight ≥ 2 errors that the t = 1 code cannot correct). Always 0 for decode_multiframe. The complement of corrected_frames within corrupted_frames: `corrupted_frames == corrected_frames

• uncorrectable_frames` after correction.

Trait Implementations

impl Clone for DecodedMultiframe

fn clone(&self) -> DecodedMultiframe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodedMultiframe

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

Formats the value using the given formatter.

impl Eq for DecodedMultiframe

impl PartialEq for DecodedMultiframe

fn eq(&self, other: &DecodedMultiframe) -> 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 StructuralPartialEq for DecodedMultiframe