Skip to main content

ExpireStats

Struct ExpireStats 

Source
#[non_exhaustive]
pub struct ExpireStats { pub sampled: u32, pub expired: u32, pub rounds: u32, }
Expand description

What Store::tick_expire saw and did. Surfaced for tests, INFO keyspace, and (eventually) Wave 2 task #4’s crash-safe verifier.

use kevy_store::{ExpireStats, Store};
let mut s = Store::new();
// no TTL-bearing keys: the reaper does no work at all
assert_eq!(s.tick_expire(16, 16), ExpireStats::default());

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.
§sampled: u32

Total TTL-bearing keys sampled across all rounds.

use core::time::Duration;
use kevy_store::{SetCondition, Store};
let mut s = Store::new();
s.set(b"live", b"v".to_vec(), Some(Duration::from_secs(60)), SetCondition::Always);
// the walk starts at a random bucket, so one key may or may not be seen
let stats = s.tick_expire(16, 1);
assert!(stats.sampled <= 1);
assert_eq!(stats.expired, 0);
§expired: u32

How many of those were past their deadline and got removed.

use core::time::Duration;
use kevy_store::{SetCondition, Store};
let mut s = Store::new();
for k in [b"a", b"b"] {
    s.set(k, b"v".to_vec(), Some(Duration::from_millis(1)), SetCondition::Always);
}
let mut expired = 0;
for _ in 0..500 {
    expired += s.tick_expire(16, 16).expired;
    if s.dbsize() == 0 {
        break;
    }
    std::thread::sleep(Duration::from_millis(2));
}
assert_eq!(expired, 2);
§rounds: u32

Rounds executed before the loop exited (either max_rounds reached or in-batch expire-rate dropped below the continuation threshold).

use core::time::Duration;
use kevy_store::{SetCondition, Store};
let mut s = Store::new();
s.set(b"live", b"v".to_vec(), Some(Duration::from_secs(60)), SetCondition::Always);
// nothing is due, so the tick stops well short of its 8-round budget
let stats = s.tick_expire(16, 8);
assert!((1..=3).contains(&stats.rounds));

Trait Implementations§

Source§

impl Clone for ExpireStats

Source§

fn clone(&self) -> ExpireStats

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 ExpireStats

Source§

impl Debug for ExpireStats

Source§

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

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

impl Default for ExpireStats

Source§

fn default() -> ExpireStats

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

impl Eq for ExpireStats

Source§

impl Hash for ExpireStats

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 ExpireStats

Source§

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

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.