Skip to main content

ResponseCache

Struct ResponseCache 

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

Cache middleware, see the module documentation. Cloning gives another handle to the same cache.

Implementations§

Source§

impl ResponseCache

Source

pub fn new() -> Self

Source

pub fn ttl(self, ttl: Duration) -> Self

Lifetime of responses that do not say otherwise (default 60 seconds)

Source

pub fn stale_while_revalidate(self, window: Duration) -> Self

Serve an expired response for this long while one request refreshes it in the background (default off)

Source

pub fn max_entries(self, max: usize) -> Self

Most cached responses (default 1000); the oldest go first

Source

pub fn max_body(self, bytes: usize) -> Self

Largest body that is cached (default 1 MiB)

Source

pub fn statuses<I: IntoIterator<Item = u16>>(self, statuses: I) -> Self

Status codes worth caching (default only 200)

Source

pub fn vary_by<I, S>(self, headers: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Request headers that change the response (Accept-Language, …): each distinct value gets its own entry, and Vary is added to the response

Source

pub fn per_user(self) -> Self

Cache requests that carry Authorization or Cookie too, with a separate entry per credential. Only for responses that depend on nothing but the credential itself.

Source

pub fn invalidate_prefix(&self, prefix: &str)

Drop every cached response whose path starts with prefix

Source

pub fn clear(&self)

Drop everything

Source

pub fn len(&self) -> usize

Number of cached responses

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Clone for ResponseCache

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ResponseCache

Source§

fn default() -> Self

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

impl Middleware for ResponseCache

Source§

fn handle<'life0, 'async_trait>( &'life0 self, req: Request, next: Next, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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