Skip to main content

CacheKitBuilder

Struct CacheKitBuilder 

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

Fluent builder for CacheKit.

Implementations§

Source§

impl CacheKitBuilder

Source

pub fn backend(self, backend: SharedBackend) -> Self

Set the storage backend.

Source

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

Override the default TTL (used when no per-call TTL is specified).

Source

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

Set a namespace prefix. All keys will be stored as {namespace}:{key}.

Source

pub fn max_payload_bytes(self, limit: usize) -> Self

Set the maximum accepted payload size in bytes.

Source

pub fn l1_capacity(self, capacity: usize) -> Self

Set the L1 cache capacity (max entries).

Source

pub fn no_l1(self) -> Self

Disable the L1 cache entirely.

Source

pub fn encryption_from_bytes( self, master_key: &[u8], tenant_id: &str, ) -> Result<Self, CachekitError>

Configure encryption from raw master key bytes and tenant ID.

The master key must be at least 16 bytes (32 recommended). Keys are derived per-tenant via HKDF-SHA256.

Source

pub fn encryption( self, hex_key: &str, tenant_id: &str, ) -> Result<Self, CachekitError>

Configure encryption from a hex-encoded master key string.

Convenience wrapper that hex-decodes then delegates to Self::encryption_from_bytes.

Source

pub fn build(self) -> Result<CacheKit, CachekitError>

Finalise and build the CacheKit client.

Returns an error if no backend was provided.

Trait Implementations§

Source§

impl Default for CacheKitBuilder

Source§

fn default() -> CacheKitBuilder

Returns the “default value” for a type. 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: 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> 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, 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