amnesia 0.1.5

An expressive interface for interacting with a 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use serde::{de::DeserializeOwned, Serialize};
use std::{future::Future, time::Duration};

#[cfg(feature = "database")]
pub mod database;
#[cfg(feature = "dynamodb")]
pub mod dynamodb;
#[cfg(feature = "memory")]
pub mod memory;
pub mod null;
#[cfg(feature = "redis")]
pub mod redis;

#[cfg(feature = "database")]
pub use database::DatabaseDriver;
#[cfg(feature = "dynamodb")]
pub use dynamodb::DynamoDBDriver;
#[cfg(feature = "memory")]
pub use memory::MemoryDriver;
pub use null::NullDriver;
#[cfg(feature = "redis")]
pub use redis::RedisDriver;

/// Cache driver.
pub trait Driver: Sized + Send + Sync {
	type Error: Send;
	type Config: Send;

	fn new(config: Self::Config) -> impl Future<Output = Result<Self, Self::Error>> + Send;

	/// Get a value from the cache.
	fn get<T: DeserializeOwned>(
		&self,
		key: &str,
	) -> impl Future<Output = Result<Option<T>, Self::Error>> + Send;

	/// Check if a value exists in the cache.
	fn has(&self, key: &str) -> impl Future<Output = Result<bool, Self::Error>> + Send;

	/// Put a value into the cache.
	fn put<T: Serialize + Sync>(
		&mut self,
		key: &str,
		data: &T,
		expiry: Option<Duration>,
	) -> impl Future<Output = Result<(), Self::Error>> + Send;

	/// Remove a value from the cache.
	fn forget(&mut self, key: &str) -> impl Future<Output = Result<(), Self::Error>> + Send;

	/// Remove all values from the cache.
	fn flush(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send;
}