Skip to main content

CacheControlMiddleware

Struct CacheControlMiddleware 

Source
pub struct CacheControlMiddleware { /* private fields */ }
Expand description

Middleware for setting HTTP cache control headers.

This middleware adds Cache-Control, Vary, and optionally Expires headers to responses. It supports various caching strategies from no-cache to aggressive caching for static assets.

§Features

  • Cache-Control directives: Full support for RFC 7234 directives
  • Vary header: Content negotiation support for Accept-Encoding, Accept-Language, etc.
  • Expires header: Optional legacy header support
  • Per-route configuration: Apply different policies via middleware stacks
  • Method filtering: Only cache GET/HEAD by default
  • Status filtering: Only cache successful responses

§Example

use fastapi_core::middleware::{CacheControlMiddleware, CacheControlConfig, CachePreset};

// No caching for API responses (default)
let api_cache = CacheControlMiddleware::new();

// Public caching for static assets
let static_cache = CacheControlMiddleware::with_preset(CachePreset::StaticAssets);

// Custom caching with Vary header
let custom_cache = CacheControlMiddleware::with_config(
    CacheControlConfig::from_preset(CachePreset::PublicOneHour)
        .vary("Accept-Encoding")
        .vary("Accept-Language")
        .with_expires(true)
);

// CDN-friendly caching
let cdn_cache = CacheControlMiddleware::with_preset(CachePreset::CdnFriendly);

§Response Headers Set

HeaderDescription
Cache-ControlMain caching directive
VaryHeaders that affect caching
ExpiresLegacy expiration (if enabled)

Implementations§

Source§

impl CacheControlMiddleware

Source

pub fn new() -> Self

Create middleware with default no-cache policy.

This is the safest default - no caching unless explicitly configured.

Source

pub fn with_preset(preset: CachePreset) -> Self

Create middleware with a preset caching policy.

Source

pub fn with_config(config: CacheControlConfig) -> Self

Create middleware with custom configuration.

Trait Implementations§

Source§

impl Default for CacheControlMiddleware

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Middleware for CacheControlMiddleware

Source§

fn after<'a>( &'a self, _ctx: &'a RequestContext, req: &'a Request, response: Response, ) -> BoxFuture<'a, Response>

Called after the handler executes. Read more
Source§

fn name(&self) -> &'static str

Returns the middleware name for debugging and logging. Read more
Source§

fn before<'a>( &'a self, _ctx: &'a RequestContext, _req: &'a mut Request, ) -> BoxFuture<'a, ControlFlow>

Called before the handler executes. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T