TieredCacheBuilder

Struct TieredCacheBuilder 

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

Builder for creating configured TieredCache instances

This builder provides a fluent interface for configuring tiered cache instances with L1 (memory) and L2 (Redis) layers.

§Example

use oxcache::builder::TieredCacheBuilder;
use std::time::Duration;

let backend = TieredCacheBuilder::new()
    .l1_capacity(10000)
    .l1_ttl(Duration::from_secs(3600))
    .l2_connection_string("redis://localhost:6379")
    .l2_mode(RedisMode::Standalone)
    .auto_promote(true)
    .batch_writes(true)
    .build()?;

Implementations§

Source§

impl TieredCacheBuilder

Source

pub fn new() -> Self

Create a new tiered cache builder with default settings

§Returns

TieredCacheBuilder instance

Source

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

Set the L1 cache capacity

§Arguments
  • capacity - Maximum number of entries in L1 cache
§Returns

Self for method chaining

§Example
let builder = TieredCacheBuilder::new().l1_capacity(10000);
Source

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

Set the L1 cache TTL

§Arguments
  • ttl - Time-to-live duration for L1 entries
§Returns

Self for method chaining

§Example
use std::time::Duration;

let builder = TieredCacheBuilder::new().l1_ttl(Duration::from_secs(3600));
Source

pub fn l2_connection_string(self, connection_string: &str) -> Self

Set the L2 Redis connection string

§Arguments
  • connection_string - Redis connection URL
§Returns

Self for method chaining

§Example
let builder = TieredCacheBuilder::new()
    .l2_connection_string("redis://localhost:6379");
Source

pub fn l2_mode(self, mode: RedisMode) -> Self

Set the L2 Redis mode

§Arguments
  • mode - Redis mode (Standalone, Sentinel, Cluster)
§Returns

Self for method chaining

§Example
use oxcache::backend::RedisMode;

let builder = TieredCacheBuilder::new()
    .l2_mode(RedisMode::Standalone);
Source

pub fn auto_promote(self, enabled: bool) -> Self

Enable or disable auto-promote

When enabled, values from L2 are automatically promoted to L1 on cache misses.

§Arguments
  • enabled - Whether to enable auto-promote
§Returns

Self for method chaining

§Example
let builder = TieredCacheBuilder::new().auto_promote(true);
Source

pub fn batch_writes(self, enabled: bool) -> Self

Enable or disable batch writes

When enabled, multiple write operations are batched for better performance.

§Arguments
  • enabled - Whether to enable batch writes
§Returns

Self for method chaining

§Example
let builder = TieredCacheBuilder::new().batch_writes(true);
Source

pub fn bloom_filter(self, enabled: bool) -> Self

Enable or disable bloom filter

When enabled, a bloom filter is used to prevent cache penetration attacks.

§Arguments
  • enabled - Whether to enable bloom filter
§Returns

Self for method chaining

§Example
let builder = TieredCacheBuilder::new().bloom_filter(true);
Source

pub async fn build(self) -> Result<Arc<dyn CacheBackend>>

Build the tiered cache backend

§Returns

Configured TieredBackend instance

§Errors

Returns CacheError if configuration is invalid or backend creation fails

§Example
let backend = TieredCacheBuilder::new()
    .l1_capacity(10000)
    .l2_connection_string("redis://localhost:6379")
    .build()?;

Trait Implementations§

Source§

impl Default for TieredCacheBuilder

Source§

fn default() -> Self

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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, 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<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§

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