pub struct CloudflareInvalidator { /* private fields */ }Expand description
Build absolute URLs the public router is serving by joining the
tenant’s public host with the supplied url_path. Cloudflare’s
purge API accepts full URLs (https://example.com/about/) and
drops the matching edge entry on every PoP. Per-tenant deploys
typically map one tenant to one origin host; multi-host setups
can register the additional hosts via
CloudflareInvalidator::with_tenant_host.
Construct with CloudflareInvalidator::new; chain .with_*
configuration calls before installing on the admin router.
Implementations§
Source§impl CloudflareInvalidator
impl CloudflareInvalidator
Sourcepub fn new(zone_id: impl Into<String>, api_token: impl Into<String>) -> Self
pub fn new(zone_id: impl Into<String>, api_token: impl Into<String>) -> Self
Build a fresh invalidator. The HTTP client uses the framework’s default 10-second timeout + exponential-backoff retry policy.
§Panics
If the framework HTTP client cannot be constructed (no TLS backend available, etc.). This is a startup-time failure; crashing loudly is better than silently dropping every purge.
Sourcepub fn with_origin_host(self, host: impl Into<String>) -> Self
pub fn with_origin_host(self, host: impl Into<String>) -> Self
Single-tenant convenience — every invalidation targets
<scheme>://<host><url_path> regardless of tenant slug.
Multi-tenant setups should use Self::with_tenant_host
instead so each tenant resolves to its own public host(s).
Sourcepub fn with_tenant_host(
self,
tenant_slug: impl Into<String>,
host: impl Into<String>,
) -> Self
pub fn with_tenant_host( self, tenant_slug: impl Into<String>, host: impl Into<String>, ) -> Self
Register an additional public host for tenant_slug. The
same page URL gets purged for every registered host; useful
when a tenant is served under both acme.example.com and a
vanity domain acme.com.
Sourcepub fn with_scheme(self, scheme: impl Into<String>) -> Self
pub fn with_scheme(self, scheme: impl Into<String>) -> Self
Override the URL scheme (default: https). Useful for
localhost / dev where the public origin is HTTP-only.
Sourcepub fn with_api_base(self, api_base: impl Into<String>) -> Self
pub fn with_api_base(self, api_base: impl Into<String>) -> Self
Override the Cloudflare API base URL. Used by tests to point at an httpmock server; production keeps the default.
Purge by cache-tag. Cloudflare Enterprise stamps
responses with Cache-Tag headers; purging a tag drops every
edge entry carrying it in one call — far cheaper than
enumerating URLs. The CMS doesn’t auto-tag responses, so this
is a public hook: a host that sets Cache-Tag (e.g. per
page-type or per snippet) calls this after the relevant save.
No-op on non-Enterprise zones (the API rejects tags).
Sourcepub async fn purge_prefixes(&self, prefixes: Vec<String>)
pub async fn purge_prefixes(&self, prefixes: Vec<String>)
Purge by URL prefix — Enterprise-only. Drops every
edge entry whose URL starts with one of prefixes
(example.com/blog/), i.e. a true subtree purge without
enumerating each descendant. No-op on non-Enterprise zones.
Trait Implementations§
Source§impl PageCacheInvalidator for CloudflareInvalidator
impl PageCacheInvalidator for CloudflareInvalidator
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 CloudflareInvalidator
impl !UnwindSafe for CloudflareInvalidator
impl Forget for CloudflareInvalidator
impl Freeze for CloudflareInvalidator
impl Send for CloudflareInvalidator
impl Sync for CloudflareInvalidator
impl Unpin for CloudflareInvalidator
impl UnsafeUnpin for CloudflareInvalidator
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