hitbox

Hitbox is an asynchronous caching framework supporting multiple backends and suitable for distributed and for single-machine applications.

Framework integrations

• [x] Actix

• [ ] Actix-Web

  Features

  • [x] Automatic cache key generation.
  • [x] Multiple cache backend implementations:
  • [x] Stale cache mechanics.
  • [ ] Cache locks for dogpile effect preventions.
  • [ ] Distributed cache locks.
  • [ ] Detailed metrics out of the box.

Backend implementations

• [x] Redis
• [ ] In-memory backend

Feature flags

• derive - Support for Cacheable trait derive macros.
• metrics - Support for metrics.

Restrictions

Default cache key implementation based on serde_qs crate and have some restrictions.

Documentation

• API Documentation
• Examples

Example

Dependencies:

[dependencies]
hitbox = "0.1"

Code:

First, you should derive Cacheable trait for your struct or enum:

use hitbox::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Cacheable, Serialize)] // With features=["derive"]
struct Ping {
    id: i32,
}

Or implement that trait manually:

use hitbox::{Cacheable, CacheError};
struct Ping { id: i32 }
impl Cacheable for Ping {
    fn cache_key(&self) -> Result<String, CacheError> {
        Ok(format!("{}::{}", self.cache_key_prefix(), self.id))
    }

    fn cache_key_prefix(&self) -> String { "Ping".to_owned() }
}