Skip to main content

FeOxDbBackend

Struct FeOxDbBackend 

Source
pub struct FeOxDbBackend<S = JsonFormat, C = PassthroughCompressor>
where S: Format, C: Compressor,
{ /* private fields */ }
Expand description

Disk-based cache backend using FeOxDB.

Use this when cache data must survive restarts or doesn’t fit in memory. For pure speed without persistence, prefer MokaBackend.

use hitbox_feoxdb::FeOxDbBackend;

// Persistent cache with defaults
let backend = FeOxDbBackend::builder()
    .path("/var/cache/myapp")
    .build()?;

// With resource limits
let backend = FeOxDbBackend::builder()
    .path("/var/cache/myapp")
    .max_file_size(10 * 1024 * 1024 * 1024)  // 10 GB
    .max_memory(256 * 1024 * 1024)           // 256 MB
    .build()?;

Cloning is cheap — clones share the same underlying database.

Implementations§

Source§

impl<S, C> FeOxDbBackend<S, C>
where S: Format, C: Compressor,

Source

pub fn flush(&self)

Forces pending writes to disk.

FeOxDB buffers writes in memory and flushes them periodically (~100ms). Call this when you need to ensure data is persisted before proceeding, or in tests to verify disk behavior synchronously.

No-op in memory-only mode.

Source§

impl FeOxDbBackend<JsonFormat, PassthroughCompressor>

Source

pub fn builder() -> FeOxDbBackendBuilder<JsonFormat, PassthroughCompressor>

Starts building a new backend.

Source

pub fn in_memory() -> Result<Self, FeOxDbError>

In-memory backend for tests.

Data is lost when dropped. Equivalent to builder().build().

use hitbox_feoxdb::FeOxDbBackend;

let backend = FeOxDbBackend::in_memory()
    .expect("Failed to create in-memory backend");

Trait Implementations§

Source§

impl<S, C> Backend for FeOxDbBackend<S, C>
where S: Format + Send + Sync, C: Compressor + Send + Sync,

Source§

fn read<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 CacheKey, ) -> Pin<Box<dyn Future<Output = BackendResult<Option<CacheValue<Raw>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read raw cached data by key. Read more
Source§

fn write<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 CacheKey, value: CacheValue<Raw>, ) -> Pin<Box<dyn Future<Output = BackendResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Write raw data to cache.
Source§

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 CacheKey, ) -> Pin<Box<dyn Future<Output = BackendResult<DeleteStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove data from cache.
Source§

fn value_format(&self) -> &dyn Format

Serialization format for cached values. Default: BincodeFormat.
Source§

fn key_format(&self) -> &CacheKeyFormat

Key serialization format. Default: CacheKeyFormat::Bitcode.
Source§

fn compressor(&self) -> &dyn Compressor

Compressor for cached values. Default: PassthroughCompressor.
Source§

fn label(&self) -> BackendLabel

Backend label for metrics and source path composition. Read more
Source§

impl<S, C> CacheBackend for FeOxDbBackend<S, C>
where S: Format + Send + Sync, C: Compressor + Send + Sync,

Source§

fn get<T>( &self, key: &CacheKey, ctx: &mut SmallBox<dyn Context, S4>, ) -> impl Future<Output = Result<Option<CacheValue<<T as CacheableResponse>::Cached>>, BackendError>> + Send

Retrieve a typed value from cache. Read more
Source§

fn set<T>( &self, key: &CacheKey, value: &CacheValue<<T as CacheableResponse>::Cached>, ctx: &mut SmallBox<dyn Context, S4>, ) -> impl Future<Output = Result<(), BackendError>> + Send

Store a typed value in cache. Read more
Source§

fn delete( &self, key: &CacheKey, _ctx: &mut SmallBox<dyn Context, S4>, ) -> impl Future<Output = Result<DeleteStatus, BackendError>> + Send

Delete a value from cache. Read more
Source§

impl<S, C> Clone for FeOxDbBackend<S, C>
where S: Format + Clone, C: Compressor + Clone,

Source§

fn clone(&self) -> FeOxDbBackend<S, C>

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

Auto Trait Implementations§

§

impl<S, C> Freeze for FeOxDbBackend<S, C>
where S: Freeze, C: Freeze,

§

impl<S = JsonFormat, C = PassthroughCompressor> !RefUnwindSafe for FeOxDbBackend<S, C>

§

impl<S, C> Send for FeOxDbBackend<S, C>

§

impl<S, C> Sync for FeOxDbBackend<S, C>

§

impl<S, C> Unpin for FeOxDbBackend<S, C>
where S: Unpin, C: Unpin,

§

impl<S = JsonFormat, C = PassthroughCompressor> !UnwindSafe for FeOxDbBackend<S, C>

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> Compose for T
where T: Backend,

Source§

fn compose<L2, O>(self, l2: L2, offload: O) -> CompositionBackend<Self, L2, O>
where L2: Backend, O: Offload<'static>,

Compose this backend with another backend as L2, using default policies. Read more
Source§

fn compose_with<L2, O, R, W>( self, l2: L2, offload: O, policy: CompositionPolicy<R, W>, ) -> CompositionBackend<Self, L2, O, R, W>

Compose this backend with another backend as L2, using custom policies. 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> 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<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