Struct CacheControlBuilder 

pub struct CacheControlBuilder { /* private fields */ }

Builder for constructing Cache-Control header values.

Provides a fluent API for building complex cache control policies.

Example

use fastapi_core::middleware::CacheControlBuilder;

// Public, cacheable for 1 hour, must revalidate after
let cache = CacheControlBuilder::new()
    .public()
    .max_age_secs(3600)
    .must_revalidate()
    .build();

// Private, no caching
let no_cache = CacheControlBuilder::new()
    .private()
    .no_store()
    .build();

// CDN-friendly: public with different browser/CDN TTLs
let cdn = CacheControlBuilder::new()
    .public()
    .max_age_secs(60)        // Browser caches for 1 minute
    .s_maxage_secs(3600)     // CDN caches for 1 hour
    .build();

Implementations

impl CacheControlBuilder

pub fn new() -> Self

Create a new empty Cache-Control builder.

pub fn public(self) -> Self

Add the public directive - response may be cached by any cache.

pub fn private(self) -> Self

Add the private directive - response may only be cached by browser.

pub fn no_store(self) -> Self

Add the no-store directive - response must not be cached.

pub fn no_cache(self) -> Self

Add the no-cache directive - must revalidate before using cache.

pub fn no_transform(self) -> Self

Add the no-transform directive - caches must not modify response.

pub fn must_revalidate(self) -> Self

Add the must-revalidate directive - cache must check origin when stale.

pub fn proxy_revalidate(self) -> Self

Add the proxy-revalidate directive - shared caches must check origin when stale.

pub fn immutable(self) -> Self

Add the immutable directive - response won’t change during freshness lifetime.

pub fn max_age_secs(self, seconds: u32) -> Self

Set max-age directive - maximum time response is fresh (in seconds).

pub fn max_age(self, duration: Duration) -> Self

Set max-age directive from a Duration.

pub fn s_maxage_secs(self, seconds: u32) -> Self

Set s-maxage directive - maximum time for shared caches (in seconds).

pub fn s_maxage(self, duration: Duration) -> Self

Set s-maxage directive from a Duration.

pub fn stale_while_revalidate_secs(self, seconds: u32) -> Self

Set stale-while-revalidate directive - serve stale while revalidating (in seconds).

pub fn stale_if_error_secs(self, seconds: u32) -> Self

Set stale-if-error directive - serve stale if origin errors (in seconds).

pub fn build(&self) -> String

Build the Cache-Control header value string.

pub fn is_no_cache(&self) -> bool

Check if this represents a no-cache policy.

Trait Implementations

impl Clone for CacheControlBuilder

fn clone(&self) -> CacheControlBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheControlBuilder

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

Formats the value using the given formatter.

impl Default for CacheControlBuilder

fn default() -> CacheControlBuilder

Returns the “default value” for a type.