Struct r6stats_client::Client

pub struct Client { /* fields omitted */ }

Client for the R6Stats-API.

Use this client to send authenticated requests to the r6stats-api.

Ratelimiting

The API is (normally) ratelimited to 60 requests per minute. To prevent HTTP 429 errors, ratelimits are enforced prior to sending requests by Ratelimit.

Implementations

impl Client

pub fn new(token: &str) -> Result<Self, Error>

Creates a new client with default ratelimiting.

Args

• token - The API key for authentication with the endpoint

pub fn with_ratelimit<F>(token: &str, op: F) -> Result<Self, Error> where
    F: FnOnce(RatelimitBuilder) -> RatelimitBuilder, 

Creates a new client with custom ratelimit settings.

Args

• token - The API key for authentication with the endpoint
• op - Closure for building the Ratelimit

pub fn stats(&self) -> &StatsClient

Returns the client for requests to the stats endpoint.

pub fn leaderboard(&self) -> &LeaderboardClient

Returns the client for requests to the leaderboard endpoint.

pub async fn ratelimit<'_>(&'_ self) -> Ratelimit

Returns the current ratelimit.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.