Skip to main content

ResponseCache

Struct ResponseCache 

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

Cache successful GET responses in a KvStore.

Implementations§

Source§

impl ResponseCache

Source

pub fn new(store: Arc<dyn KvStore>) -> Self

Source

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

Source

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

Source

pub fn vary(self, headers: &[&str]) -> Self

Source

pub fn cache_private(self, yes: bool) -> Self

Allow caching requests that carry Authorization / Cookie.

Source

pub fn prefix(self, prefix: impl Into<String>) -> Self

Source

pub async fn invalidate_prefix(&self, path_prefix: &str) -> u64

Invalidate keys under path_prefix (same as ResponseCacheHandle::invalidate_prefix).

Typical pattern with sova_core::EventBus:

let handle = app.try_state::<ResponseCacheHandle>().unwrap();
bus.listen::<NoteCreated, _>(move |_| {
    let h = handle.clone();
    tokio::spawn(async move { h.invalidate_prefix("/api/notes").await; });
});
Source

pub fn middleware(self) -> MwEntry

Trait Implementations§

Source§

impl Clone for ResponseCache

Source§

fn clone(&self) -> ResponseCache

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 Plugin for ResponseCache

Source§

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

Stable plugin identifier used for dependency checks and crate::App::has_plugin. Read more
Source§

fn meta(&self) -> PluginMeta

Display name, description, and declared PluginMeta::sdk version.
Source§

fn install(self, app: &mut App)

Register middleware, state, routes, and hooks on app.
Source§

fn requires(&self) -> &'static [&'static str]

Required plugin ids that must be installed beforehand. 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> 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> 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 = 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