Struct WithChecksum 

pub struct WithChecksum<C, T>
where
    C: CodeqConfig,
{ /* private fields */ }

A wrapper that appends a checksum to the encoded data.

During encoding, the inner data is first encoded, then a checksum of the encoded data is calculated and appended. During decoding, the inner data is first decoded, then the checksum is verified against the decoded data. If the checksums do not match, an error is returned.

The generic parameter C specifies the checksum configuration to use for protecting the data.

Example:

use codeq::config::Crc32fast;

let wc = WithChecksum::<Crc32fast, u64>::new(5);
let mut b = Vec::new();
let n = wc.encode(&mut b).unwrap();
assert_eq!(n, 16);
assert_eq!(
    vec![
        0, 0, 0, 0, 0, 0, 0, 5, // data
        0, 0, 0, 0, 21, 72, 43, 230, // checksum
    ],
    b
);

Create a new wrapper with either WithChecksum::new or CodeqConfig::wrap, for example:

let wc = Crc32fast::wrap(5);

Implementations

impl<C, T> WithChecksum<C, T>

where C: CodeqConfig,

pub fn new(data: T) -> Self

Creates a new wrapper around the given data.

pub fn into_inner(self) -> T

Unwraps and returns the inner data

Trait Implementations

impl<C, T: Clone> Clone for WithChecksum<C, T>

where C: CodeqConfig + Clone,

fn clone(&self) -> WithChecksum<C, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, T: Debug> Debug for WithChecksum<C, T>

where C: CodeqConfig + Debug,

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

Formats the value using the given formatter.

impl<C, T> Decode for WithChecksum<C, T>

where C: CodeqConfig, T: Decode,

fn decode<R: Read>(r: R) -> Result<Self, Error>

impl<C, T> Encode for WithChecksum<C, T>

where C: CodeqConfig, T: Encode,

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

fn encode_to_vec(&self) -> Result<Vec<u8>, Error>

where Self: Sealed,

Encodes the value into a new Vec<u8>.

impl<C, T> FixedSize for WithChecksum<C, T>

where C: CodeqConfig, T: FixedSize,

fn encoded_size() -> usize

Returns the size in bytes that this type will occupy when encoded.

impl<C, T: PartialEq> PartialEq for WithChecksum<C, T>

where C: CodeqConfig + PartialEq,

fn eq(&self, other: &WithChecksum<C, T>) -> 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<C, T: Eq> Eq for WithChecksum<C, T>

where C: CodeqConfig + Eq,

impl<C, T> StructuralPartialEq for WithChecksum<C, T>

where C: CodeqConfig,