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
impl VarnishInvalidator
Sourcepub fn new(backend_urls: Vec<String>) -> Self
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.
Sourcepub fn with_method(self, method: impl Into<String>) -> Self
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
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,
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,
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,
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,
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,
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,
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§
impl !RefUnwindSafe for VarnishInvalidator
impl !UnwindSafe for VarnishInvalidator
impl Forget for VarnishInvalidator
impl Freeze for VarnishInvalidator
impl Send for VarnishInvalidator
impl Sync for VarnishInvalidator
impl Unpin for VarnishInvalidator
impl UnsafeUnpin for VarnishInvalidator
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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