Struct CacheService 

pub struct CacheService { /* private fields */ }

Service for purging cache.

Obtain an instance via CloudflareClient::cache().

Implementations

impl CacheService

pub async fn purge_everything( &self, zone_id: impl Into<String>, ) -> Result<PurgeResponse>

Purge all cached content for a zone.

Warning: This will purge everything from the cache and may significantly increase load on your origin server.

Examples

client.cache()
    .purge_everything("zone_id")
    .await?;

pub fn purge_urls(&self, zone_id: impl Into<String>) -> PurgeUrlsRequest

Purge specific URLs from cache.

You can purge up to 30 URLs at a time.

Examples

client.cache()
    .purge_urls("zone_id")
    .urls(vec![
        "https://example.com/page1",
        "https://example.com/page2",
    ])
    .send()
    .await?;

pub fn purge_tags(&self, zone_id: impl Into<String>) -> PurgeTagsRequest

Purge cache by cache tags.

Cache tags are used to identify cached content. You can purge up to 30 tags at a time. This feature requires an Enterprise plan.

Examples

client.cache()
    .purge_tags("zone_id")
    .tags(vec!["product", "blog"])
    .send()
    .await?;

pub fn purge_hosts(&self, zone_id: impl Into<String>) -> PurgeHostsRequest

Purge cache by hosts.

Purge all cached content for specific hosts. You can purge up to 30 hosts at a time. This feature requires an Enterprise plan.

Examples

client.cache()
    .purge_hosts("zone_id")
    .hosts(vec!["www.example.com", "api.example.com"])
    .send()
    .await?;

pub fn purge_prefixes(&self, zone_id: impl Into<String>) -> PurgePrefixesRequest

Purge cache by prefixes.

Purge all cached content with URLs that begin with specific prefixes. You can purge up to 30 prefixes at a time. This feature requires an Enterprise plan.

Examples

client.cache()
    .purge_prefixes("zone_id")
    .prefixes(vec!["example.com/images/", "example.com/videos/"])
    .send()
    .await?;

Trait Implementations

impl Clone for CacheService

fn clone(&self) -> CacheService

Returns a duplicate of the value.

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

Performs copy-assignment from source.