Skip to main content

ReconcileReport

Struct ReconcileReport 

Source
#[non_exhaustive]
pub struct ReconcileReport { pub rows: u64, pub expected: u64, pub missing_count: u64, pub missing: Vec<Vec<u8>>, pub orphaned_count: u64, pub orphaned: Vec<Vec<u8>>, }
Expand description

The result of Snapshot::reconcile.

assert!(kevy_embedded::ReconcileReport::default().is_clean());

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§rows: u64

Rows visited under the row prefix.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
assert_eq!(report.rows, 3);
§expected: u64

Distinct derived keys the rows imply.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
assert_eq!(report.expected, 3);
§missing_count: u64

Implied by a row, absent from the store — lost derived state. Exact count; missing holds up to 1000 examples.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
assert_eq!(report.missing_count, 2);
§missing: Vec<Vec<u8>>

Example missing keys.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
let mut missing = report.missing.clone();
missing.sort();
assert_eq!(missing, [b"idx:user:2".to_vec(), b"idx:user:3".to_vec()]);
§orphaned_count: u64

Present under a derived prefix but implied by no row — a claim or link left behind. Exact count; orphaned holds examples.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
assert_eq!(report.orphaned_count, 1);
§orphaned: Vec<Vec<u8>>

Example orphaned keys.

// three rows, each implying `idx:<key>`; idx:user:1 exists, idx:user:9 has no row
assert_eq!(report.orphaned, [b"idx:user:9".to_vec()]);

Implementations§

Source§

impl ReconcileReport

Source

pub fn is_clean(&self) -> bool

Whether the rows and their derived keys agree exactly.

Source

pub fn truncated(&self) -> bool

Whether the sample lists were cut short — the counts are still exact, so a caller logging only samples should say so.

Trait Implementations§

Source§

impl Clone for ReconcileReport

Source§

fn clone(&self) -> Self

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 ReconcileReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReconcileReport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ReconcileReport

Source§

impl Hash for ReconcileReport

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ReconcileReport

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ReconcileReport

Auto Trait Implementations§

Blanket Implementations§

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<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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.