oiseau 0.3.0

Super simple SQL helper
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
54
55
56

#![allow(async_fn_in_trait)]

#[cfg(feature = "redis")]
pub mod redis;

#[cfg(not(feature = "redis"))]
pub mod no_cache;

/// A simple cache "database".
pub trait Cache {
    type Item;
    type Client;

    /// Create a new [`Cache`].
    async fn new() -> Self;
    /// Get a connection to the cache.
    async fn get_con(&self) -> Self::Client;

    /// Get a cache object by its identifier
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    async fn get(&self, id: Self::Item) -> Option<String>;
    /// Set a cache object by its identifier and content
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    /// * `content` - `String` of the object's content
    async fn set(&self, id: Self::Item, content: Self::Item) -> bool;
    /// Update a cache object by its identifier and content
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    /// * `content` - `String` of the object's content
    async fn update(&self, id: Self::Item, content: Self::Item) -> bool;
    /// Remove a cache object by its identifier
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    async fn remove(&self, id: Self::Item) -> bool;
    /// Remove a cache object by its identifier('s start)
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id('s start)
    async fn remove_starting_with(&self, id: Self::Item) -> bool;
    /// Increment a cache object by its identifier
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    async fn incr(&self, id: Self::Item) -> bool;
    /// Decrement a cache object by its identifier
    ///
    /// # Arguments
    /// * `id` - `String` of the object's id
    async fn decr(&self, id: Self::Item) -> bool;
}