Struct CacheMiddleware

Source

pub struct CacheMiddleware<B, C, CM> { /* private fields */ }

Expand description

Cache middleware for reqwest-middleware.

This middleware intercepts HTTP requests and responses, caching them according to the configured policy and predicates.

Use CacheMiddleware::builder() to construct an instance. See the crate-level documentation for usage examples.

Implementations§

Source §

impl<B, C, CM> CacheMiddleware<B, C, CM>

Source

pub fn new( backend: Arc, configuration: C, concurrency_manager: CM, cache_status_header: HeaderName, ) -> Self

Creates a new cache middleware with explicit components.

For most use cases, prefer CacheMiddleware::builder() which provides a more ergonomic API with sensible defaults.

Source §

impl CacheMiddleware<NotSet, NotSet, NoopConcurrencyManager>

Source

pub fn builder() -> CacheMiddlewareBuilder<NotSet, NotSet, NoopConcurrencyManager>

Creates a new builder for constructing cache middleware.

Both backend() and config() must be called before build().

See the crate-level documentation for usage examples.

Trait Implementations§

Source §

impl<B, C, CM> Clone for CacheMiddleware<B, C, CM>
where C: Clone, CM: Clone,

Source §

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<B, C, CM> Middleware for CacheMiddleware<B, C, CM>
where B: CacheBackend + Send + Sync + 'static, C: CacheConfig<CacheableHttpRequest<Body>, CacheableHttpResponse<Body>> + Clone + Send + Sync + 'static, C::RequestPredicate: Clone + Send + Sync + 'static, C::ResponsePredicate: Clone + Send + Sync + 'static, C::Extractor: Clone + Send + Sync + 'static, CM: ConcurrencyManager<Result<CacheableHttpResponse<Body>>> + Clone + Send + Sync + 'static,

Source §

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

Invoked with a request before sending it. If you want to continue processing the request, you should explicitly call next.run(req, extensions). Read more

Auto Trait Implementations§

§

impl<B, C, CM> !Freeze for CacheMiddleware<B, C, CM>

§

impl<B, C, CM> RefUnwindSafe for CacheMiddleware<B, C, CM>
where C: RefUnwindSafe, CM: RefUnwindSafe, B: RefUnwindSafe,

§

impl<B, C, CM> Send for CacheMiddleware<B, C, CM>
where C: Send, CM: Send, B: Sync + Send,

§

impl<B, C, CM> Sync for CacheMiddleware<B, C, CM>
where C: Sync, CM: Sync, B: Sync + Send,

§

impl<B, C, CM> Unpin for CacheMiddleware<B, C, CM>
where C: Unpin, CM: Unpin,

§

impl<B, C, CM> UnwindSafe for CacheMiddleware<B, C, CM>
where C: UnwindSafe, CM: UnwindSafe, B: RefUnwindSafe,

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 §

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 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> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

Source §

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

Source §

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

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

Source §

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

Source §

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source §

fn vzip(self) -> V

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 §

CacheMiddleware

Struct CacheMiddleware Copy item path

Implementations§

impl<B, C, CM> CacheMiddleware<B, C, CM>

pub fn new( backend: Arc<B>, configuration: C, concurrency_manager: CM, cache_status_header: HeaderName, ) -> Self

impl CacheMiddleware<NotSet, NotSet, NoopConcurrencyManager>

pub fn builder() -> CacheMiddlewareBuilder<NotSet, NotSet, NoopConcurrencyManager>

Trait Implementations§

impl<B, C, CM> Clone for CacheMiddleware<B, C, CM>where C: Clone, CM: Clone,

fn clone(&self) -> Self

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

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

Auto Trait Implementations§

impl<B, C, CM> !Freeze for CacheMiddleware<B, C, CM>

impl<B, C, CM> RefUnwindSafe for CacheMiddleware<B, C, CM>where C: RefUnwindSafe, CM: RefUnwindSafe, B: RefUnwindSafe,

impl<B, C, CM> Send for CacheMiddleware<B, C, CM>where C: Send, CM: Send, B: Sync + Send,

impl<B, C, CM> Sync for CacheMiddleware<B, C, CM>where C: Sync, CM: Sync, B: Sync + Send,

impl<B, C, CM> Unpin for CacheMiddleware<B, C, CM>where C: Unpin, CM: Unpin,

impl<B, C, CM> UnwindSafe for CacheMiddleware<B, C, CM>where C: UnwindSafe, CM: UnwindSafe, B: RefUnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> PolicyExt for Twhere T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>where T: Policy<B, E>, P: Policy<B, E>,

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<A, B, T> HttpServerConnExec<A, B> for Twhere B: Body,

Struct CacheMiddleware

impl<B, C, CM> Clone for CacheMiddleware<B, C, CM>
where C: Clone, CM: Clone,

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

impl<B, C, CM> RefUnwindSafe for CacheMiddleware<B, C, CM>
where C: RefUnwindSafe, CM: RefUnwindSafe, B: RefUnwindSafe,

impl<B, C, CM> Send for CacheMiddleware<B, C, CM>
where C: Send, CM: Send, B: Sync + Send,

impl<B, C, CM> Sync for CacheMiddleware<B, C, CM>
where C: Sync, CM: Sync, B: Sync + Send,

impl<B, C, CM> Unpin for CacheMiddleware<B, C, CM>
where C: Unpin, CM: Unpin,

impl<B, C, CM> UnwindSafe for CacheMiddleware<B, C, CM>
where C: UnwindSafe, CM: UnwindSafe, B: RefUnwindSafe,

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

impl<T> DynClone for T
where T: Clone,

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

impl<T> ToOwned for T
where T: Clone,

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,