Skip to main content

InvalidationContext

Struct InvalidationContext 

Source
pub struct InvalidationContext {
    pub modified_views: Vec<String>,
    pub reason: InvalidationReason,
}
Expand description

Context for cache invalidation operations.

Encapsulates which views/tables were modified and why, providing structured information for logging and debugging.

§Example

use fraiseql_core::cache::InvalidationContext;

// Invalidate after mutation
let ctx = InvalidationContext::for_mutation(
    "createUser",
    vec!["v_user".to_string()]
);

// Invalidate manually
let ctx = InvalidationContext::manual(
    vec!["v_user".to_string(), "v_post".to_string()],
    "data import completed"
);

// Invalidate on schema change
let ctx = InvalidationContext::schema_change(
    vec!["v_user".to_string()],
    "1.0.0",
    "1.1.0"
);

Fields§

§modified_views: Vec<String>

List of views/tables that were modified.

All cache entries accessing these views will be invalidated.

§reason: InvalidationReason

Reason for invalidation.

Used for structured logging and debugging.

Implementations§

Source§

impl InvalidationContext

Source

pub fn for_mutation(mutation_name: &str, modified_views: Vec<String>) -> Self

Create invalidation context for a mutation.

Used by mutation handlers to invalidate cache entries after modifying data.

§Arguments
  • mutation_name - Name of the mutation (e.g., “createUser”)
  • modified_views - List of views/tables modified by the mutation
§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::for_mutation(
    "createUser",
    vec!["v_user".to_string()]
);

assert_eq!(ctx.modified_views, vec!["v_user"]);
Source

pub fn manual(modified_views: Vec<String>, reason: &str) -> Self

Create invalidation context for manual invalidation.

Used by administrators or background jobs to manually invalidate cache entries (e.g., after data import, during maintenance).

§Arguments
  • modified_views - List of views/tables to invalidate
  • reason - Human-readable reason for audit logging
§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::manual(
    vec!["v_user".to_string(), "v_post".to_string()],
    "maintenance: rebuilding indexes"
);

assert_eq!(ctx.modified_views.len(), 2);
Source

pub fn schema_change( affected_views: Vec<String>, old_version: &str, new_version: &str, ) -> Self

Create invalidation context for schema change.

Used during deployments when the schema version changes to flush all cached entries that depend on the old schema structure.

§Arguments
  • affected_views - All views in the schema (typically all views)
  • old_version - Previous schema version
  • new_version - New schema version
§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::schema_change(
    vec!["v_user".to_string(), "v_post".to_string()],
    "1.0.0",
    "1.1.0"
);

assert_eq!(ctx.modified_views.len(), 2);
Source

pub fn to_log_string(&self) -> String

Get a log-friendly description of this invalidation.

§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::for_mutation(
    "createUser",
    vec!["v_user".to_string()]
);

assert_eq!(
    ctx.to_log_string(),
    "mutation:createUser affecting 1 view(s)"
);
Source

pub fn view_count(&self) -> usize

Get the number of views affected by this invalidation.

§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::manual(
    vec!["v_user".to_string(), "v_post".to_string()],
    "maintenance"
);

assert_eq!(ctx.view_count(), 2);
Source

pub fn affects_view(&self, view: &str) -> bool

Check if this invalidation affects a specific view.

§Arguments
  • view - View name to check
§Example
use fraiseql_core::cache::InvalidationContext;

let ctx = InvalidationContext::for_mutation(
    "createUser",
    vec!["v_user".to_string(), "v_post".to_string()]
);

assert!(ctx.affects_view("v_user"));
assert!(ctx.affects_view("v_post"));
assert!(!ctx.affects_view("v_comment"));

Trait Implementations§

Source§

impl Clone for InvalidationContext

Source§

fn clone(&self) -> InvalidationContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvalidationContext

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more