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

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

use std::{ops::Deref, time::Duration};

use async_trait::async_trait;
pub use in_memory::BucketRateLimiter;
pub use noop::NoopRateLimiter;

#[cfg(feature = "redis")]
pub use self::redis::RedisRateLimiter;
use crate::EndpointError;

#[async_trait]
pub trait RateLimiter {
    /// takes the amount of requests
    /// returns the seconds to wait before executing them
    async fn take(&self, num: usize) -> Result<Duration, EndpointError>;
    /// incurs a penalty, indicating that the rate limit was hit
    async fn penalize(&self) -> Result<(), EndpointError>;
}

#[async_trait]
impl<T, K> RateLimiter for T
where
    T: Deref<Target = K> + Sync,
    K: RateLimiter + Sync,
{
    async fn take(&self, num: usize) -> Result<Duration, EndpointError> {
        self.deref().take(num).await
    }

    async fn penalize(&self) -> Result<(), EndpointError> {
        self.deref().penalize().await
    }
}