rosu 0.6.0

An osu!api v1 wrapper
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

use super::{Osu, OsuRef};
use crate::{ratelimit::RateLimiter, OsuError, OsuResult};

#[cfg(feature = "metrics")]
use crate::metrics::Metrics;

use reqwest::ClientBuilder as ReqwestClientBuilder;
use std::{sync::Arc, time::Duration};

/// A builder for the main [`Osu`] client.
#[derive(Debug)]
pub struct OsuBuilder {
    reqwest_client: Option<ReqwestClientBuilder>,
    timeout: Duration,
    api_key: Box<str>,
}

impl OsuBuilder {
    /// Create a new builder to build an [`Osu`] struct.
    pub fn new(api_key: impl Into<Box<str>>) -> Self {
        Self {
            timeout: Duration::from_secs(10),
            reqwest_client: None,
            api_key: api_key.into(),
        }
    }

    /// Build the [`Osu`] struct.
    ///
    /// # Errors
    ///
    /// Errors if `reqwest` fails to build the client
    pub fn build(self) -> OsuResult<Osu> {
        let http = self
            .reqwest_client
            .unwrap_or_else(ReqwestClientBuilder::new)
            .timeout(self.timeout)
            .build()
            .map_err(OsuError::BuildingClient)?;

        let inner = OsuRef {
            http,
            api_key: self.api_key,
            ratelimiter: RateLimiter::new(15, 1),
            #[cfg(feature = "metrics")]
            metrics: Metrics::new(),
        };

        Ok(Osu(Arc::new(inner)))
    }

    /// Set a pre-configured reqwest client builder to build off of.
    ///
    /// The timeout settings in the reqwest client will be overwritten by
    /// those in this builder.
    ///
    /// The default client uses Rustls as its TLS backend.
    pub fn reqwest_client(mut self, client: ReqwestClientBuilder) -> Self {
        self.reqwest_client.replace(client);

        self
    }

    /// Set the timeout for HTTP requests, defaults to 10 seconds.
    pub fn timeout(mut self, duration: Duration) -> Self {
        self.timeout = duration;

        self
    }
}