Enum CacheEvent 

#[non_exhaustive]
pub enum CacheEvent {
    Hit {
        key: Arc<str>,
        stale: bool,
    },
    Miss {
        key: Arc<str>,
    },
    Set {
        key: Arc<str>,
    },
    Remove {
        key: Arc<str>,
    },
    Expire {
        key: Arc<str>,
    },
    FactorySuccess {
        key: Arc<str>,
    },
    FactoryError {
        key: Arc<str>,
        message: String,
    },
    FactorySyntheticTimeout {
        key: Arc<str>,
    },
    FailSafeActivate {
        key: Arc<str>,
    },
    EagerRefresh {
        key: Arc<str>,
    },
    BackgroundFactorySuccess {
        key: Arc<str>,
    },
    BackgroundFactoryError {
        key: Arc<str>,
        message: String,
    },
    RemoveByTag {
        tag: String,
    },
    Clear,
    Eviction {
        key: Arc<str>,
    },
    CircuitBreakerChange {
        component: CircuitComponent,
        closed: bool,
    },
    SerializationError {
        key: Arc<str>,
        message: String,
    },
    DeserializationError {
        key: Arc<str>,
        message: String,
    },
    MessagePublished {
        key: Arc<str>,
    },
    MessageReceived {
        key: Arc<str>,
    },
}

An observable cache event.

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.

Hit

A value was served. stale is true when it came from a fail-safe / stale fallback rather than a fresh entry.

Fields

key: Arc<str>

The cache key.

stale: bool

Whether the served value was stale.

Miss

Nothing servable was found for the key.

Fields

key: Arc<str>

The cache key.

Set

A value was written to the cache.

Fields

key: Arc<str>

The cache key.

Remove

A key was removed.

Fields

key: Arc<str>

The cache key.

Expire

A key was logically expired.

Fields

key: Arc<str>

The cache key.

FactorySuccess

The factory completed successfully on the foreground path.

Fields

key: Arc<str>

The cache key.

FactoryError

The factory returned an error.

Fields

key: Arc<str>

The cache key.

message: String

The failure message.

FactorySyntheticTimeout

The factory exceeded a (soft or hard) timeout.

Fields

key: Arc<str>

The cache key.

FailSafeActivate

A stale value was served because the factory failed or timed out.

Fields

key: Arc<str>

The cache key.

EagerRefresh

A proactive background refresh was started.

Fields

key: Arc<str>

The cache key.

BackgroundFactorySuccess

A timed-out factory later completed successfully in the background.

Fields

key: Arc<str>

The cache key.

BackgroundFactoryError

A timed-out factory later failed in the background.

Fields

key: Arc<str>

The cache key.

message: String

The failure message.

RemoveByTag

All entries carrying a tag were invalidated.

Fields

tag: String

The tag.

Clear

The whole cache was cleared.

Eviction

An entry was evicted from L1 by the backend’s size/expiry policy.

Fields

key: Arc<str>

The cache key.

CircuitBreakerChange

A distributed-cache or backplane circuit breaker opened or closed.

Fields

component: CircuitComponent

Which component the breaker guards.

closed: bool

true if the breaker is now closed (healthy), false if open.

SerializationError

A value failed to serialize for L2.

Fields

key: Arc<str>

The cache key.

message: String

The error message.

DeserializationError

A value failed to deserialize from L2.

Fields

key: Arc<str>

The cache key.

message: String

The error message.

MessagePublished

A backplane notification was published to peers.

Fields

key: Arc<str>

The cache key.

MessageReceived

A backplane notification was received from a peer.

Fields

key: Arc<str>

The cache key.

Trait Implementations

impl Clone for CacheEvent

fn clone(&self) -> CacheEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheEvent

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

Formats the value using the given formatter.

impl Eq for CacheEvent

impl PartialEq for CacheEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CacheEvent