Skip to main content

StorageChecksumEngine

Struct StorageChecksumEngine 

Source
pub struct StorageChecksumEngine {
    pub algorithm: ChecksumAlgorithm,
    pub verify_on_read: bool,
    /* private fields */
}
Expand description

Multi-algorithm checksum engine for storage integrity verification.

Stores one ChecksumRecord per object and allows efficient batch computation and verification.

Fields§

§algorithm: ChecksumAlgorithm

Default algorithm used for new computations.

§verify_on_read: bool

When true, callers are encouraged to verify on every read.

Implementations§

Source§

impl StorageChecksumEngine

Source

pub fn new(algorithm: ChecksumAlgorithm) -> Self

Create a new engine with the given default algorithm.

Source

pub fn compute(&self, data: &[u8]) -> Checksum

Compute a checksum for data using the engine’s current algorithm.

Source

pub fn compute_with_algorithm( algorithm: ChecksumAlgorithm, data: &[u8], ) -> Checksum

Compute a checksum for data using the specified algorithm.

Source

pub fn compute_for( &mut self, object_id: String, data: &[u8], now: u64, ) -> ChecksumRecord

Compute a checksum for data, store the resulting record, and return it.

Source

pub fn verify( &mut self, object_id: &str, data: &[u8], now: u64, ) -> Option<CeVerificationResult>

Compare the stored checksum for object_id with a freshly computed one.

Returns None when no record exists for object_id. On a successful match the record’s verified_at is updated to now.

Source

pub fn record(&self, object_id: &str) -> Option<&ChecksumRecord>

Retrieve the stored record for object_id, if any.

Source

pub fn remove(&mut self, object_id: &str) -> bool

Remove the record for object_id. Returns true if the record existed.

Source

pub fn verify_all( &mut self, data_fn: impl Fn(&str) -> Option<Vec<u8>>, now: u64, ) -> Vec<CeVerificationResult>

Verify all stored records by calling data_fn for each object_id.

If data_fn returns None for a given id the object is skipped.

Source

pub fn batch_compute( &mut self, items: &[(&str, &[u8])], now: u64, ) -> Vec<ChecksumRecord>

Compute and store checksums for a batch of (object_id, data) pairs.

Source

pub fn corruption_count(results: &[CeVerificationResult]) -> usize

Count the number of verification results where !matches.

Source

pub fn object_count(&self) -> usize

Number of objects currently tracked.

Source

pub fn stats(&self, results: &[CeVerificationResult]) -> ChecksumStats

Compute aggregate statistics from the engine’s state and a set of results.

Trait Implementations§

Source§

impl Clone for StorageChecksumEngine

Source§

fn clone(&self) -> StorageChecksumEngine

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StorageChecksumEngine

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more