Skip to main content

VarnishInvalidator

Struct VarnishInvalidator 

Source
pub struct VarnishInvalidator { /* private fields */ }
Expand description

Send BAN requests to a fixed list of Varnish backend URLs on every invalidation. The request body is empty; the path carries the URL to purge (matching the VCL ban("req.url == ...") rule).

Construct with VarnishInvalidator::new; chain .with_* configuration calls before installing on the admin router.

Implementations§

Source§

impl VarnishInvalidator

Source

pub fn new(backend_urls: Vec<String>) -> Self

Build a fresh invalidator. The HTTP client uses a 5-second timeout — Varnish’s admin port is on the same network as the CMS by convention, so a tight timeout surfaces config problems quickly without blocking the admin handler.

§Panics

If the framework HTTP client cannot be constructed (no TLS backend available, etc.). Startup-time failure; crashing loudly is better than silently dropping every BAN.

Source

pub fn with_method(self, method: impl Into<String>) -> Self

Override the HTTP method (default: BAN). Some custom VCL setups want PURGE instead. Tests use this to fall back to POST because httpmock doesn’t parse arbitrary methods.

Trait Implementations§

Source§

impl PageCacheInvalidator for VarnishInvalidator

Source§

fn invalidate_url<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _tenant: &'life1 TenantSlug, url_path: &'life2 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Drop the cache entry for the public render of url_path on the given tenant (slug and org id, as the page cache keys it). Hosts pass the unprefixed page URL — the implementation appends the configured URL prefix + host(s) before computing the cache key.
Source§

fn invalidate_subtree<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _tenant: &'life1 TenantSlug, url_path: &'life2 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Drop every cache entry whose URL starts with url_path / (the page itself + every descendant). Called after a slug rename, a move, or a subtree delete.
Source§

fn invalidate_urls<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tenant: &'life1 TenantSlug, url_paths: &'life2 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Drop the cache entries for many page URLs at once. The default loops over Self::invalidate_url — preserving the per-URL behavior — but backends with a bulk-purge API (Cloudflare files, Azure CDN contentPaths) should override this to issue a single request instead of N. The purge fan-out in crate::task_queue::purge_urls calls this so a batch backend collapses a multi-URL save into one round-trip.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, 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.
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