Struct CacheInvalidationRule 

#[non_exhaustive]
pub struct CacheInvalidationRule {
    pub cache_tags: Vec<String>,
    pub host: Option<String>,
    pub path: Option<String>,
    /* private fields */
}

Available on crate feature url-maps only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cache_tags: Vec<String>

A list of cache tags used to identify cached objects.

• Cache tags are specified when the response is first cached, by setting the Cache-Tag response header at the origin.
• Multiple cache tags in the same invalidation request are treated as Boolean OR - for example, tag1 OR tag2 OR tag3.
• If other fields are also specified, these are treated as Boolean AND with any tags.

Up to 10 tags can be specified in a single invalidation request.

host: Option<String>

If set, this invalidation rule will only apply to requests with a Host header matching host.

path: Option<String>

Implementations

impl CacheInvalidationRule

pub fn new() -> Self

pub fn set_cache_tags<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of cache_tags.

Example

let x = CacheInvalidationRule::new().set_cache_tags(["a", "b", "c"]);

pub fn set_host<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of host.

Example

let x = CacheInvalidationRule::new().set_host("example");

pub fn set_or_clear_host<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of host.

Example

let x = CacheInvalidationRule::new().set_or_clear_host(Some("example"));
let x = CacheInvalidationRule::new().set_or_clear_host(None::<String>);

pub fn set_path<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of path.

Example

let x = CacheInvalidationRule::new().set_path("example");

pub fn set_or_clear_path<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of path.

Example

let x = CacheInvalidationRule::new().set_or_clear_path(Some("example"));
let x = CacheInvalidationRule::new().set_or_clear_path(None::<String>);

Trait Implementations

impl Clone for CacheInvalidationRule

fn clone(&self) -> CacheInvalidationRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheInvalidationRule

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

Formats the value using the given formatter.

impl Default for CacheInvalidationRule

fn default() -> CacheInvalidationRule

Returns the “default value” for a type.

impl Message for CacheInvalidationRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CacheInvalidationRule

fn eq(&self, other: &CacheInvalidationRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheInvalidationRule