Struct Crc 

pub struct Crc { /* private fields */ }

A cyclic redundancy check of degree width and generator poly (without its leading term), valid by construction (Crc::new checks them).

Implementations

impl Crc

pub fn new(name: &'static str, width: u32, poly: u64) -> Result<Crc>

A CRC of degree width (1 to 64) and generator poly without its leading term.

Errors

Error::Config for a degree outside 1 to 64 or a generator with bits above it.

pub fn name(&self) -> &'static str

Name of the CRC.

pub fn width(&self) -> u32

Degree $L$.

pub fn poly(&self) -> u64

Generator polynomial without its leading term $D^{L}$.

pub fn crc24a() -> Crc

CRC24A of 5G NR.

pub fn crc24b() -> Crc

CRC24B of 5G NR.

pub fn crc24c() -> Crc

CRC24C of 5G NR.

pub fn crc16() -> Crc

CRC16 of 5G NR and of LTE, $g_{\mathrm{CRC16}}(D) = D^{16} + D^{12} + D^{5} + 1$ (CCITT).

pub fn crc11() -> Crc

CRC11 of 5G NR.

pub fn crc6() -> Crc

CRC6 of 5G NR.

pub fn from_name(name: &str) -> Result<Crc>

A CRC of 5G NR by name: crc24a, crc24b, crc24c, crc16, crc11 or crc6 (case-insensitive).

Errors

Error::Config for another name.

pub fn checksum(&self, bits: &[u8]) -> Vec<u8>

The $L$ parity bits of bits: the remainder of $b(D), D^{L}$ by the generator (comnum_math::gf2::poly_rem).

pub fn attach(&self, bits: &[u8]) -> Vec<u8>

bits followed by their parity bits.

pub fn check(&self, word: &[u8]) -> bool

Whether a word (information then parity bits) passes the check.

Trait Implementations

impl Clone for Crc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Crc

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

Formats the value using the given formatter.

impl Eq for Crc

impl PartialEq for Crc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Crc