[go: up one dir, main page]

crc 0.3.0

Rust implementation of CRC(32, 64)
Documentation

crc Build Status

Rust implementation of CRC(32, 64)

##Usage Add crc to Cargo.toml

[dependencies]
crc = "0.3.0"

or

[dependencies.crc]
git = "https://github.com/mrhooray/crc-rs"

Add this to crate root

extern crate crc;

Compute CRC32

use crc::{crc32, Hasher32};

// CRC-32-IEEE being the most commonly used one
assert_eq!(crc32::checksum_ieee(b"123456789"), 0xcbf43926);
assert_eq!(crc32::checksum_castagnoli(b"123456789"), 0xe3069283);
assert_eq!(crc32::checksum_koopman(b"123456789"), 0x2d3dd0ae);

// use provided or custom polynomial
let mut digest = crc32::Digest::new(crc32::IEEE);
digest.write(b"123456789");
assert_eq!(digest.sum32(), 0xcbf43926);

Compute CRC64

use crc::{crc64, Hasher64};

assert_eq!(crc64::checksum_ecma(b"123456789"), 0x995dc9bbdf1939fa);
assert_eq!(crc64::checksum_iso(b"123456789"), 0xb90956c775a41001);

// use provided or custom polynomial
let mut digest = crc64::Digest::new(crc64::ECMA);
digest.write(b"123456789");
assert_eq!(digest.sum64(), 0x995dc9bbdf1939fa);

##Benchmark cargo bench with 2.3 GHz Intel Core i7 results ~400MB/s throughput. Comparison

running 14 tests
test crc32::tests::test_checksum_castagnoli ... ignored
test crc32::tests::test_checksum_ieee ... ignored
test crc32::tests::test_checksum_koopman ... ignored
test crc32::tests::test_digest_castagnoli ... ignored
test crc32::tests::test_digest_ieee ... ignored
test crc32::tests::test_digest_koopman ... ignored
test crc64::tests::test_checksum_ecma ... ignored
test crc64::tests::test_checksum_iso ... ignored
test crc64::tests::test_digest_ecma ... ignored
test crc64::tests::test_digest_iso ... ignored
test crc32::tests::bench_make_table       ... bench:       447 ns/iter (+/- 81)
test crc32::tests::bench_update_megabytes ... bench:   2479741 ns/iter (+/- 183031)
test crc64::tests::bench_make_table       ... bench:      1166 ns/iter (+/- 93)
test crc64::tests::bench_update_megabytes ... bench:   2478464 ns/iter (+/- 68731)

test result: ok. 0 passed; 0 failed; 10 ignored; 4 measured

##TODO

##License MIT