bincache 0.5.1

ZitaneLabs binary cache.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use async_trait::async_trait;
use std::borrow::Cow;

use crate::{CacheCapacity, Result};

use super::CacheKey;

/// A cache strategy.
#[async_trait]
pub trait CacheStrategy {
    /// This type is opaque to the cache.
    /// It is used to store information about each cached data entry.
    type CacheEntry;

    /// Setup the cache.
    async fn setup(&mut self) -> Result<()> {
        Ok(())
    }

    /// Put a value into the cache.
    async fn put<'a, K, V>(&mut self, key: &K, value: V) -> Result<Self::CacheEntry>
    where
        K: CacheKey + Sync + Send,
        V: Into<Cow<'a, [u8]>> + Send;

    /// Get a value from the cache.
    async fn get<'a>(&self, entry: &'a Self::CacheEntry) -> Result<Cow<'a, [u8]>>;

    /// Take a value from the cache, removing it.
    async fn take(&mut self, entry: Self::CacheEntry) -> Result<Vec<u8>>;

    /// Delete a value from the cache.
    async fn delete(&mut self, entry: Self::CacheEntry) -> Result<()>;

    /// Get cache capacity. Returns None if no limit was set.
    fn get_cache_capacity(&self) -> Option<CacheCapacity>;
}