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

//! # r6stats Client
//!
//! This crate provides a client for the r6stats API. It supports the `/stats` and the `/leaderboard` endpoint.
//!
//! ## Example
//! ```rust
//! use r6stats_client::{Client, Platform, Region};
//! use std::env;
//!
//! #[tokio::main]
//! async fn main() {
//!     // You need an API key to access the endpoints of r6stats.
//!     //
//!     // If you don't have one, you can request one from their support.
//!     let token = "<API KEY HERE>";
//!     # let token = std::env::var("R6STATS_TOKEN").unwrap();
//!     let client = Client::new(token).unwrap();
//!
//!     let leaderboard = client
//!         .leaderboard()
//!         .get(Platform::Pc, Some(Region::Emea))
//!         .await
//!         .unwrap();
//!
//!     println!("{:#?}", leaderboard);
//! }
//! ```
//!
//! More examples can be found in the [examples] directory.
//!
//! ## Features
//!
//! - `ratelimiting` (default): Enables pre-ratelimiting **before** sending requests to prevent HTTP-429 Errors.
//! **Note**: Ratelimits are enforced by the server either way.
//! - `threadsafe`: Makes [`Client`] threadsafe (`Send` + `Sync`)
//!
//! [examples]: https://github.com/Jan561/r6stats_client/tree/master/examples
//! [`Client`]: client/struct.Client.html

#[macro_use]
mod internals;

pub mod http;
pub mod leaderboard;
pub mod stats;

mod client;
mod error;
mod platform;
mod region;

pub use crate::client::Client;
pub use crate::error::Error;
pub use crate::platform::Platform;
pub use crate::region::Region;

use crate::http::Http;