Skip to main content

Config

Struct Config 

Source
pub struct Config<ReqPred, ResPred, Ext> { /* private fields */ }
Expand description

Generic cache configuration.

A protocol-agnostic configuration that holds predicates, extractors, and policy. Use this with any protocol (HTTP, gRPC, etc.) by providing appropriate predicates and extractors.

§Example

use hitbox::{Config, Extractor, KeyParts};
use hitbox::policy::PolicyConfig;
use hitbox::predicate::Neutral;
use std::time::Duration;

let config = Config::builder()
    .request_predicate(Neutral::<String>::new())
    .response_predicate(Neutral::<String>::new())
    .extractor(FixedKeyExtractor)
    .policy(PolicyConfig::builder().ttl(Duration::from_secs(60)).build())
    .build();

Implementations§

Trait Implementations§

Source§

impl<Req, Res, ReqPred, ResPred, Ext> CacheConfig<Req, Res> for Config<ReqPred, ResPred, Ext>
where Req: Send, Res: Send, ReqPred: Predicate<Subject = Req> + Send + Sync + 'static, ResPred: Predicate<Subject = Res> + Send + Sync + 'static, Ext: Extractor<Subject = Req> + Send + Sync + 'static,

Source§

type RequestPredicate = Arc<ReqPred>

Predicate type for filtering requests.
Source§

type ResponsePredicate = Arc<ResPred>

Predicate type for filtering responses.
Source§

type Extractor = Arc<Ext>

Extractor type for generating cache keys.
Source§

fn request_predicates( &self, ) -> <Config<ReqPred, ResPred, Ext> as CacheConfig<Req, Res>>::RequestPredicate

Returns predicates that decide if a request should be cached.
Source§

fn response_predicates( &self, ) -> <Config<ReqPred, ResPred, Ext> as CacheConfig<Req, Res>>::ResponsePredicate

Returns predicates that decide if a response should be cached.
Source§

fn extractors( &self, ) -> <Config<ReqPred, ResPred, Ext> as CacheConfig<Req, Res>>::Extractor

Returns extractors that generate cache keys from requests.
Source§

fn policy(&self) -> &PolicyConfig

Returns TTL and behavior policy for cached entries.
Source§

impl<ReqPred, ResPred, Ext> Clone for Config<ReqPred, ResPred, Ext>

Source§

fn clone(&self) -> Config<ReqPred, ResPred, Ext>

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<ReqPred, ResPred, Ext> Debug for Config<ReqPred, ResPred, Ext>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<ReqPred, ResPred, Ext> Freeze for Config<ReqPred, ResPred, Ext>

§

impl<ReqPred, ResPred, Ext> RefUnwindSafe for Config<ReqPred, ResPred, Ext>
where ReqPred: RefUnwindSafe, ResPred: RefUnwindSafe, Ext: RefUnwindSafe,

§

impl<ReqPred, ResPred, Ext> Send for Config<ReqPred, ResPred, Ext>
where ReqPred: Sync + Send, ResPred: Sync + Send, Ext: Sync + Send,

§

impl<ReqPred, ResPred, Ext> Sync for Config<ReqPred, ResPred, Ext>
where ReqPred: Sync + Send, ResPred: Sync + Send, Ext: Sync + Send,

§

impl<ReqPred, ResPred, Ext> Unpin for Config<ReqPred, ResPred, Ext>

§

impl<ReqPred, ResPred, Ext> UnwindSafe for Config<ReqPred, ResPred, Ext>
where ReqPred: RefUnwindSafe, ResPred: RefUnwindSafe, Ext: 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§

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

Source§

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

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> 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> 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 = 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