Module brawl_api::model

Contains models for each documented Brawl Stars API endpoint.

All models derive/implement the following traits:

• Debug
• Clone
• Hash
• PartialEq
• Eq
• serde::ser::Serialize
• serde::de::Deserialize
• Default (except for Smart Pointer models, such as all -Leaderboards and BattleLog).

A few may also implement PartialOrd and Ord, such as all -Ranking structs and the pair ClubMember and ClubMemberRole.

In addition, each endpoint has a different way of fetching, and is associated with a submodule:

• /players/:tag -> Player::fetch (through the PropFetchable trait), model::players::player module;
• /players/:tag/battlelog -> BattleLog::fetch (through the PropFetchable trait), model::players::battlelog module;
• /clubs/:tag -> Club::fetch (through the PropFetchable trait), model::clubs module;
• /clubs/:tag/members -> ClubMembers::fetch (through the PropFetchable trait), model::clubs::members module;
• /rankings/:country_code/players?limit=x -> PlayerLeaderboard::fetch (through the PropLimFetchable trait), model::rankings::players module;
• /rankings/:country_code/clubs?limit=x -> ClubLeaderboard::fetch (through the PropLimFetchable trait), model::rankings::clubs module;
• /rankings/:country_code/brawlers/:brawler_id?limit=x -> BrawlerLeaderboard::fetch (direct implementation; no fetching-related traits), model::rankings::brawlers module;
• /brawlers/ -> BrawlerList::fetch (direct implementation), model::brawlers module;
• /brawlers/:id -> Brawler::fetch (direct implementation), model::brawlers module.

Re-exports

pub use common::*;

pub use players::*;

pub use clubs::*;

pub use rankings::*;

pub use brawlers::*;

Modules

brawlers	Contains models related to the /brawlers/... endpoint of the Brawl Stars API. Included by the feature "brawlers"; removing that feature will disable the usage of this module.
clubs	Models for the /clubs/:tag Brawl Stars API endpoint. Included by the feature "clubs"; removing that feature will disable the usage of this module.
common	Models shared for usage by more than one endpoint. Note that, if all the relevant endpoints' features are disabled, then the respective models here are also disabled.
players	Models for all /players/:tag/... Brawl Stars API endpoints. Included by the feature "players"; removing that feature will disable the usage of this module.
rankings	Models for all /rankings/:country_code/... Brawl Stars API endpoints. Included by the feature "rankings"; removing that feature will disable the usage of this module.