Struct SecDed64

#[repr(C)]
pub struct SecDed64 { /* private fields */ }

A very efficient SecDedCodec implementation based on u64.

Implementations

impl SecDed64

pub fn new(encodable_size: usize) -> Self

Trait Implementations

impl SecDedCodec for SecDed64

fn encode(&self, buffer: &mut [u8])

Encodes the data IN-PLACE

Arguments:

• data: The slice of data to encode. The last secded.code_size() bits MUST be set to 0.

Panics:

Panics if data.len() != 8

Unless you use the no-panics feature, encoding will also panic if the data you try to encode has some bits set to 1 in the reserved space, or past the encodable_size() + code_size() rightmost bits

fn decode(&self, buffer: &mut [u8]) -> Result<(), ()>

Decodes the data IN-PLACE

Arguments:

• data: The slice of data to decode.
  The last secded.code_size() bits will be reset to 0, a single error will be corrected implicitly.

Returns:

Ok(()) if the data slice’s correctness has been checked: 0 error found or 1 found and corrected. Err(()) if 2 errors were detected.

Panics:

Panics if data.len() != 8

fn encodable_size(&self) -> usize

Returns the number of bits that this SecDedCodec can encode.

fn code_size(&self) -> usize

Returns the size of the correction code that will be appended to the data.

fn expected_slice_size(&self) -> Option<usize>

Returns Some(size) if the implementation would panic if data.len() != size