Enum TtlReaperMode 

#[non_exhaustive]
pub enum TtlReaperMode {
    Background,
    Manual,
}

How the active TTL reaper runs.

use kevy_embedded::{Config, TtlReaperMode};

assert_eq!(Config::default().ttl_reaper, TtlReaperMode::Background);
assert_eq!(Config::default().with_ttl_reaper_manual().ttl_reaper, TtlReaperMode::Manual);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Background

Spawn a background thread that ticks at the configured interval (default 100 ms / 10 Hz, matching Redis’s hz=10). Default.

use std::time::Duration;
use kevy_embedded::{Config, Store};

let s = Store::open(Config::default())?;
s.set_with_ttl(b"k", b"v", Duration::from_millis(1))?;
// nobody calls tick(): the background thread reclaims the key
for _ in 0..500 {
    if s.info().expired_keys == 1 {
        break;
    }
    std::thread::sleep(Duration::from_millis(10));
}
assert_eq!(s.info().expired_keys, 1);

Manual

Caller-driven via crate::Store::tick. Required for WASM targets (no threads) and single-threaded apps that don’t want a background worker.

use std::time::Duration;
use kevy_embedded::{Config, Store};

let s = Store::open(Config::default().with_ttl_reaper_manual())?;
s.set_with_ttl(b"k", b"v", Duration::from_millis(1))?;
std::thread::sleep(Duration::from_millis(250));
assert_eq!(s.info().expired_keys, 0, "nothing reaps until the caller ticks");
for _ in 0..50 { s.tick(); }
assert_eq!(s.info().expired_keys, 1);

Trait Implementations

impl Clone for TtlReaperMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TtlReaperMode

impl Debug for TtlReaperMode

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

Formats the value using the given formatter.

impl Default for TtlReaperMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TtlReaperMode

impl Hash for TtlReaperMode

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TtlReaperMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TtlReaperMode