#[derive(Clone, Copy, PartialEq, Eq, Debug, Default)]
#[non_exhaustive]
pub enum CsumScheme {
#[default]
None,
Crc32c,
}
impl CsumScheme {
#[must_use]
pub const fn writes_object_checksums(self) -> bool {
match self {
Self::None => false,
Self::Crc32c => true,
}
}
#[must_use]
pub const fn uninit_bg_semantics(self) -> bool {
match self {
Self::None => false,
Self::Crc32c => true,
}
}
}
pub trait Checksummer: crate::sealed::Sealed {
fn scheme(&self) -> CsumScheme;
fn base_seed(&self) -> u32;
fn crc32c(&self, seed: u32, data: &[u8]) -> u32;
}
#[derive(Clone, Copy, Debug, Default)]
pub struct NullCsum;
impl crate::sealed::Sealed for NullCsum {}
impl Checksummer for NullCsum {
fn scheme(&self) -> CsumScheme {
CsumScheme::None
}
fn base_seed(&self) -> u32 {
0
}
fn crc32c(&self, _seed: u32, _data: &[u8]) -> u32 {
0
}
}
#[derive(Clone, Copy, Debug)]
pub struct Crc32c {
base_seed: u32,
}
impl Crc32c {
#[must_use]
pub fn new(uuid: &[u8; 16]) -> Self {
Self {
base_seed: crate::crc32c::crc32c(!0, uuid),
}
}
#[must_use]
pub fn with_seed(base_seed: u32) -> Self {
Self { base_seed }
}
}
impl crate::sealed::Sealed for Crc32c {}
impl Checksummer for Crc32c {
fn scheme(&self) -> CsumScheme {
CsumScheme::Crc32c
}
fn base_seed(&self) -> u32 {
self.base_seed
}
fn crc32c(&self, seed: u32, data: &[u8]) -> u32 {
crate::crc32c::crc32c(seed, data)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_scheme_answers_the_two_questions_separately() {
assert!(!CsumScheme::None.writes_object_checksums());
assert!(!CsumScheme::None.uninit_bg_semantics());
assert!(CsumScheme::Crc32c.writes_object_checksums());
assert!(CsumScheme::Crc32c.uninit_bg_semantics());
assert_eq!(CsumScheme::default(), CsumScheme::None);
}
#[test]
fn null_csum_is_disabled_and_zero() {
let c = NullCsum;
assert_eq!(c.scheme(), CsumScheme::None);
assert_eq!(c.base_seed(), 0);
assert_eq!(c.crc32c(0, b"anything"), 0);
assert_eq!(c.crc32c(0xdead_beef, &[1, 2, 3, 4]), 0);
}
#[test]
fn null_csum_is_usable_as_a_trait_object() {
let c: &dyn Checksummer = &NullCsum;
assert_eq!(c.scheme(), CsumScheme::None);
assert_eq!(c.crc32c(1, b""), 0);
}
#[test]
fn crc32c_seeds_from_the_uuid() {
let uuid = [
0xf0, 0xe1, 0x70, 0x55, 0, 0, 0x40, 0, 0x80, 0, 0, 0, 0, 0, 0, 0,
];
let c = Crc32c::new(&uuid);
assert_eq!(c.scheme(), CsumScheme::Crc32c);
assert_eq!(c.base_seed(), 0x33D2_8425);
assert_eq!(c.crc32c(c.base_seed(), b""), 0x33D2_8425);
}
#[test]
fn crc32c_is_usable_as_a_trait_object() {
let uuid = [0u8; 16];
let c: &dyn Checksummer = &Crc32c::new(&uuid);
assert_eq!(c.scheme(), CsumScheme::Crc32c);
}
}