Skip to main content

IndexStats

Struct IndexStats 

Source
#[non_exhaustive]
pub struct IndexStats { pub entries: u64, pub approx_bytes: u64, pub coerce_failures: u64, pub duplicates: u64, }
Expand description

Sizing + health counters (IDX.LIST / memory formula).

use kevy_index::{Segment, SegmentStats};
let s = Segment::new().stats();
assert_eq!((s.entries, s.duplicates), (0, SegmentStats::default().duplicates));

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.
§entries: u64

Live entries.

let mut s = Segment::new();
s.apply(b"a", None, Some(IndexValue::I64(1)));
s.apply(b"a", Some(&IndexValue::I64(1)), Some(IndexValue::I64(2)));
assert_eq!(s.stats().entries, 1, "a key holds one entry");
§approx_bytes: u64

Approximate heap bytes (the measured side of the documented memory formula).

let mut s = Segment::new();
s.apply(b"a", None, Some(IndexValue::Str(vec![b'x'; 1000])));
assert!(s.stats().approx_bytes >= 1000);
§coerce_failures: u64

Rows excluded because the field failed coercion / was missing.

let mut s = Segment::new();
s.apply(b"a", None, IndexValue::coerce(ValType::I64, b"not a number"));
assert_eq!(s.stats().coerce_failures, 1);
§duplicates: u64

Values currently held by more than one key (unique fence).

let mut s = Segment::new();
s.apply(b"a", None, Some(IndexValue::I64(7)));
s.apply(b"b", None, Some(IndexValue::I64(7)));
assert_eq!(s.stats().duplicates, 1);

Trait Implementations§

Source§

impl Clone for SegmentStats

Source§

fn clone(&self) -> SegmentStats

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 Copy for SegmentStats

Source§

impl Debug for SegmentStats

Source§

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

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

impl Default for SegmentStats

Source§

fn default() -> SegmentStats

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

impl Eq for SegmentStats

Source§

impl Hash for SegmentStats

Source§

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

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 SegmentStats

Source§

fn eq(&self, other: &SegmentStats) -> 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 SegmentStats

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.