Struct InvalidationPlan 

pub struct InvalidationPlan { /* private fields */ }

A database-neutral list of cache invalidations staged by repository code.

InvalidationPlan deliberately does not know about SQLx, Diesel, SeaORM, or any transaction type. Build it while preparing a write, execute the database transaction in the ORM/client you already use, and call execute only after commit succeeds. Dropping the plan on rollback leaves cached values untouched.

Example

use hydracache::HydraCache;
use hydracache_db::{HydraCacheEntity, InvalidationPlan};

#[derive(HydraCacheEntity)]
#[hydracache(entity = "user", collection = "users")]
struct User {
    #[hydracache(id)]
    id: i64,
}

let pending = InvalidationPlan::new().cache_entity::<User>(42);

// tx.update_user(42).await?;
// tx.commit().await?;

let report = pending.execute(&cache).await?;
assert_eq!(report.tag_count, 2);

Implementations

impl InvalidationPlan

pub fn new() -> InvalidationPlan

Create an empty staged invalidation plan.

pub fn key(self, key: impl Into<String>) -> InvalidationPlan

Stage one physical cache key for removal.

pub fn keys<I, S>(self, keys: I) -> InvalidationPlan

where I: IntoIterator<Item = S>, S: Into<String>,

Stage several physical cache keys for removal.

pub fn tag(self, tag: impl Into<String>) -> InvalidationPlan

Stage one invalidation tag.

pub fn tags<I, S>(self, tags: I) -> InvalidationPlan

where I: IntoIterator<Item = S>, S: Into<String>,

Stage several invalidation tags.

pub fn entity<E>(self, id: <E as CacheEntity>::Id) -> InvalidationPlan

where E: CacheEntity,

Stage the entity tag for a CacheEntity id.

pub fn collection<E>(self) -> InvalidationPlan

where E: CacheEntity,

Stage the collection tag for a CacheEntity, if it has one.

pub fn cache_entity<E>(self, id: <E as CacheEntity>::Id) -> InvalidationPlan

where E: CacheEntity,

Stage both entity and collection tags for a CacheEntity id.

pub fn is_empty(&self) -> bool

Return true when no key or tag invalidations have been staged.

pub fn key_count(&self) -> usize

Number of staged key invalidations after de-duplication.

pub fn tag_count(&self) -> usize

Number of staged tag invalidations after de-duplication.

pub fn key_values(&self) -> impl Iterator<Item = &str>

Staged keys in deterministic order.

pub fn tag_values(&self) -> impl Iterator<Item = &str>

Staged tags in deterministic order.

pub async fn execute<C>( self, cache: &HydraCache<C>, ) -> Result<InvalidationReport, CacheError>

where C: CacheCodec,

Execute all staged invalidations against the local cache after commit.

Trait Implementations

impl Clone for InvalidationPlan

fn clone(&self) -> InvalidationPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvalidationPlan

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

Formats the value using the given formatter.

impl Default for InvalidationPlan

fn default() -> InvalidationPlan

Returns the “default value” for a type.

impl Eq for InvalidationPlan

impl PartialEq for InvalidationPlan

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InvalidationPlan