CRC8-RS

A no_std library for doing 8-bit cyclic redundancy checks. This is mostly meant for embedded hardware, but it can be used in a std environment as well. This uses const generics from Rust 15.1 which is available in stable from Match 25th, 2021, before then you will have to use the Rust beta.

Usage

Add this to your project with:

toml [dependencies] crc8-rs = "1.0"

This library provides 3 main functions.

fetch_crc8(bytes: &[u8; N], poly: u8) -> u8

Returns the checksum for a given byte array and a given generator polynomial, with the last bit being the Cyclic Redundancy Check.

docs.rs

verify_crc8(bytes: &[u8; N], poly: u8) -> bool

Verify that the given byte array with the given generator polynomial has a checksum of zero.

docs.rs

insert_crc8(bytes: &[u8; N], poly: u8) -> [u8; N]

Given a byte array (with the last byte left for the CRC) and a generator polynomial, insert the CRC into the last byte of the byte array.

docs.rs

License

Licensed under a MIT license.