gw2lib 3.0.2

A simple to use Gw2 API wrapper library
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::{fmt::Display, hash::Hash, ops::Deref};

use async_trait::async_trait;
use chrono::NaiveDateTime;
use gw2lib_model::{Endpoint, Language};
use serde::{de::DeserializeOwned, Serialize};

pub(crate) mod in_memory;
pub use in_memory::InMemoryCache;
pub use noop::NoopCache;
mod noop;
#[cfg(feature = "redis")]
mod redis;

#[cfg(feature = "redis")]
pub use self::redis::RedisCache;

/// the interface for caching API responses
/// ### Remarks
/// expects the language to be part of the caching key where relevant
/// (`E::LOCALE`)
#[async_trait]
pub trait Cache {
    async fn insert<T, I, E, A>(
        &self,
        id: &I,
        endpoint: &T,
        expiring: NaiveDateTime,
        lang: Language,
        auth: &Option<A>,
    ) where
        T: DeserializeOwned + Serialize + Clone + Send + Sync + 'static,
        I: Display + Hash + Sync + 'static + ?Sized,
        E: Endpoint,
        A: Display + Hash + Sync + 'static;

    async fn get<T, I, E, A>(&self, id: &I, lang: Language, auth: &Option<A>) -> Option<T>
    where
        T: DeserializeOwned + Serialize + Clone + Send + Sync + 'static,
        I: Display + Hash + Sync + 'static + ?Sized,
        E: Endpoint,
        A: Display + Hash + Sync + 'static;

    async fn cleanup(&self);

    async fn wipe(&self) {
        self.wipe_static().await;
        self.wipe_authenticated().await;
    }

    async fn wipe_static(&self);

    async fn wipe_authenticated(&self);
}

#[async_trait]
pub(crate) trait CleanupCache {
    async fn cleanup(&self);
}

#[async_trait]
impl<T> CleanupCache for T
where
    T: Cache + Send + Sync + 'static,
{
    async fn cleanup(&self) {
        Cache::cleanup(self).await;
    }
}

#[async_trait]
impl<X, K> Cache for X
where
    X: Deref<Target = K> + Sync,
    K: Cache + Sync,
{
    async fn insert<T, I, E, A>(
        &self,
        id: &I,
        endpoint: &T,
        expiring: NaiveDateTime,
        lang: Language,
        auth: &Option<A>,
    ) where
        T: DeserializeOwned + Serialize + Clone + Send + Sync + 'static,
        I: Display + Hash + Sync + 'static + ?Sized,
        E: Endpoint,
        A: Display + Hash + Sync + 'static,
    {
        self.deref()
            .insert::<T, I, E, A>(id, endpoint, expiring, lang, auth)
            .await
    }

    async fn get<T, I, E, A>(&self, id: &I, lang: Language, auth: &Option<A>) -> Option<T>
    where
        T: DeserializeOwned + Serialize + Clone + Send + Sync + 'static,
        I: Display + Hash + Sync + 'static + ?Sized,
        E: Endpoint,
        A: Display + Hash + Sync + 'static,
    {
        self.deref().get::<T, I, E, A>(id, lang, auth).await
    }

    async fn cleanup(&self) {
        self.deref().cleanup().await
    }

    async fn wipe_static(&self) {
        self.deref().wipe_static().await
    }

    async fn wipe_authenticated(&self) {
        self.deref().wipe_authenticated().await
    }
}