Skip to content

Rust implementation of CRC(16, 32, 64) with support of various standards

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

bartelsielski/crc-rs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

crc

rust Crate Docs License

Rust implementation of CRC(8, 16, 32, 64). MSRV is 1.46.

Usage

Add crc to Cargo.toml

[dependencies]
crc = "2.0"

Compute CRC

use crc::{Crc, Algorithm, CRC_16_IBM_SDLC, CRC_32_ISCSI};

pub const X25: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_SDLC);
pub const CASTAGNOLI: Crc<u32> = Crc::<u32>::new(&CRC_32_ISCSI);

assert_eq!(X25.checksum(b"123456789"), 0x906e);
assert_eq!(CASTAGNOLI.checksum(b"123456789"), 0xe3069283);

// use custom algorithm
const CUSTOM_ALG: Algorithm<u16> = Algorithm {
    width: 16,
    poly: 0x8005,
    init: 0xffff,
    refin: false,
    refout: false,
    xorout: 0x0000,
    check: 0xaee7,
    residue: 0x0000
};
let crc = Crc::<u16>::new(&CUSTOM_ALG);
let mut digest = crc.digest();
digest.update(b"123456789");
assert_eq!(digest.finalize(), 0xaee7);

Benchmark

cargo bench with 2.6 GHz Intel Core i7. Comparison

crc16          time:   [2.0082 ms 2.0206 ms 2.0367 ms]
               thrpt:  [468.25 MiB/s 471.96 MiB/s 474.89 MiB/s]

crc32          time:   [1.7659 ms 1.7793 ms 1.7952 ms]
               thrpt:  [531.25 MiB/s 535.98 MiB/s 540.05 MiB/s]

crc64          time:   [2.0655 ms 2.0803 ms 2.0973 ms]
               thrpt:  [454.71 MiB/s 458.43 MiB/s 461.72 MiB/s]

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Rust implementation of CRC(16, 32, 64) with support of various standards

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 100.0%