Enum Route

#[non_exhaustive]
pub enum Route {
    Player(String),
    PlayerBattlelogs(String),
    Club(String),
    ClubMembers(String),
    PlayerRankings {
        country_code: String,
        limit: u8,
    },
    ClubRankings {
        country_code: String,
        limit: u8,
    },
    BrawlerRankings {
        country_code: String,
        brawler_id: usize,
        limit: u8,
    },
    Brawlers,
    Brawler(usize),
}

An enum representing the possible Brawl API routes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Player(String)

Route for the /players/:tag endpoint. (tag must begin with a # (%23) for correct results.)

This fetches a player’s data.

PlayerBattlelogs(String)

Route for the /players/:tag/battlelog endpoint. (tag must begin with a # (%23) for correct results.)

This fetches the player’s recently-played battles.

Club(String)

Route for the /clubs/:tag endpoint. (tag must begin with a # (%23) for correct results.)

This fetches a club’s data.

ClubMembers(String)

Route for the /clubs/:tag/members endpoint. (tag must begin with a # (%23) for correct results.)

This fetches a club’s members.

PlayerRankings

Route for the /rankings/:country_code/players?limit=x endpoint (shows the top x players with most trophies in said country code).

The limit can be up to 200. Specifying higher than that simply works the same way as specifying 200, thus returning up to 200 entries.

Fields

country_code: String

The two-letter country code whose leaderboard should be fetched (e.g. BR for Brazil, ZW for Zimbabwe…), or "global" for the global leaderboard.

limit: u8

The limit of rankings to get (i.e., to get the top limit players, sorted by trophies).

ClubRankings

Route for the /rankings/:country_code/clubs?limit=x endpoint.

The limit can be up to 200. Specifying higher than that simply works the same way as specifying 200, thus returning up to 200 entries.

Fields

country_code: String

The two-letter country code whose leaderboard should be fetched (e.g. BR for Brazil, ZW for Zimbabwe…), or "global" for the global leaderboard.

limit: u8

The limit of rankings to get (i.e., to get the top limit clubs, sorted by trophies).

BrawlerRankings

Route for the /rankings/:country_code/brawlers/:brawler_id?limit=x endpoint.

The limit can be up to 200. Specifying higher than that simply works the same way as specifying 200, thus returning up to 200 entries.

Fields

country_code: String

The two-letter country code whose leaderboard should be fetched (e.g. BR for Brazil, ZW for Zimbabwe…), or "global" for the global leaderboard.

brawler_id: usize

The ID of the brawler whose rankings should be fetched. To obtain this, use the /brawlers/ endpoint.

limit: u8

The limit of rankings to get (i.e., to get the top limit players, sorted by trophies on this specific brawler).

Brawlers

Route for the /brawlers/ endpoint, which returns data for all brawlers in the game.

Brawler(usize)

Route for the /brawlers/:id endpoint, which returns data for a specific brawler, given that brawler’s ID.

Implementations

impl Route

pub fn to_url_str(&self) -> String

Evaluates the Route instance into a full URL path string.

Examples

use brawl_api::Route;
assert_eq!(Route::Player("tag"), "https://api.brawlstars.com/v1/players/tag")
assert_eq!(
    Route::PlayerBattlelogs("tag"), "https://api.brawlstars.com/v1/players/tag/battlelogs"
)
assert_eq!(Route::Club("tag"), "https://api.brawlstars.com/v1/clubs/tag")
assert_eq!(Route::ClubMembers("tag"), "https://api.brawlstars.com/v1/clubs/tag/members")

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Hash for Route

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Route

fn eq(&self, other: &Route) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Route

impl StructuralPartialEq for Route