Struct stm32_hal2::crc::Polynomial

pub struct Polynomial(/* private fields */);

A CRC polynomial.

The STM32H7 CRC unit only supports odd polynomials, and the constructors will check to ensure the polynomial is odd unless the _unchecked variants are used.

Even polynomials are essentially never used in CRCs, so you most likely don’t need to worry about this if you aren’t creating your own algorithm.

A polynomial being even means that the least significant bit is 0 in the polynomial’s normal representation.

Implementations

impl Polynomial

pub fn bits7(poly: u8) -> Result<Self, PolynomialError>

Create a 7-bit polynomial. Returns an error if the polynomial passed has the MSB set or is even.

pub fn bits8(poly: u8) -> Result<Self, PolynomialError>

Create an 8-bit polynomial. Returns an error if the polynomial passed is even.

pub fn bits16(poly: u16) -> Result<Self, PolynomialError>

Create a 16-bit polynomial. Returns an error if the polynomial passed is even.

pub fn bits32(poly: u32) -> Result<Self, PolynomialError>

Create a 32-bit polynomial. Returns an error if the polynomial passed is even.

pub const fn bits7_unchecked(poly: u8) -> Self

Create a 7-bit polynomial. If the polynomial passed is even the CRC unit will give incorrect results.

pub const fn bits8_unchecked(poly: u8) -> Self

Create an 8-bit polynomial. If the polynomial passed is even the CRC unit will give incorrect results.

pub const fn bits16_unchecked(poly: u16) -> Self

Create a 16-bit polynomial. If the polynomial passed is even the CRC unit will give incorrect results.

pub const fn bits32_unchecked(poly: u32) -> Self

Create a 32-bit polynomial. If the polynomial passed is even the CRC unit will give incorrect results.

Trait Implementations

impl Clone for Polynomial

fn clone(&self) -> Polynomial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Polynomial

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

Formats the value using the given formatter.

impl Default for Polynomial

fn default() -> Self

Returns the 32-bit polynomial 0x04C1_1DB7.

impl PartialEq for Polynomial

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Polynomial

impl StructuralPartialEq for Polynomial