api_bindium 0.4.0

Framework for api binding crates
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

#[cfg(feature = "rate_limit")]
use core::num::NonZeroU32;
#[cfg(feature = "rate_limit")]
use std::sync::Arc;

#[cfg(feature = "rate_limit")]
use governor::Quota;
#[cfg(feature = "rate_limit")]
use governor::RateLimiter;
#[cfg(feature = "rate_limit")]
use governor::clock;
#[cfg(feature = "rate_limit")]
use governor::middleware::NoOpMiddleware;
#[cfg(feature = "rate_limit")]
use governor::state::InMemoryState;
#[cfg(feature = "rate_limit")]
use governor::state::NotKeyed;
use ureq::Agent;

/// The client handling the data for fetching
#[derive(Debug, bon::Builder, Clone)]
pub struct ApiClient {
    /// The [ureq::Agent] for the
    #[builder(default = ureq::agent())]
    pub agent: Agent,

    /// How many retries allowed before erroring out the request?
    #[builder(default = 10)]
    pub max_retries: u32,

    /// The inner ratelimiter
    #[cfg(feature = "rate_limit")]
    #[cfg_attr(feature = "rate_limit", builder(required, default = Some(default_ratelimit())))]
    pub rate_limit:
        Option<Arc<RateLimiter<NotKeyed, InMemoryState, clock::DefaultClock, NoOpMiddleware>>>,
}

impl ApiClient {
    /// Wait until the rate limit yield a spot
    #[cfg(feature = "rate_limit")]
    #[cfg_attr(feature = "hotpath", hotpath::measure)]
    pub async fn await_rate_limit(&self) {
        if let Some(rate) = &self.rate_limit {
            rate.until_ready().await
        }
    }
}

impl Default for ApiClient {
    fn default() -> Self {
        Self::builder().build()
    }
}

#[cfg(feature = "rate_limit")]
fn default_ratelimit()
-> Arc<RateLimiter<NotKeyed, InMemoryState, clock::DefaultClock, NoOpMiddleware>> {
    let quota =
        Quota::per_second(NonZeroU32::new(1).unwrap()).allow_burst(NonZeroU32::new(5).unwrap());
    Arc::new(RateLimiter::direct(quota))
}