Struct brawl_api::model::rankings::clubs::ClubRanking

pub struct ClubRanking {
    pub tag: String,
    pub name: String,
    pub trophies: usize,
    pub rank: u8,
    pub member_count: usize,
}

Represents a club's ranking, based on a regional or global leaderboard. To obtain the club's full data (a Club instance), see Club::fetch_from.

Fields

tag: String

The club's tag.

name: String

The club's name.

trophies: usize

The club's current trophies.

rank: u8

The club's current rank in the leaderboard.

member_count: usize

The amount of members in this club.

Trait Implementations

impl Clone for ClubRanking

fn clone(&self) -> ClubRanking

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClubRanking

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

Formats the value using the given formatter.

impl Default for ClubRanking

fn default() -> ClubRanking

Returns an instance of ClubRanking with initial values.

Examples

use brawl_api::ClubRanking;

assert_eq!(
    ClubRanking::default(),
    ClubRanking {
        tag: String::from(""),
        name: String::from(""),
        trophies: 0,
        rank: 1,
        member_count: 0,
    }
);

impl<'de> Deserialize<'de> for ClubRanking

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for ClubRanking

impl FetchFrom<ClubRanking> for Club

fn fetch_from(client: &Client, c_ranking: &ClubRanking) -> Result<Club>

(Sync) Fetches a Club using data from a ClubRanking object.

fn a_fetch_from<'life0, 'life1, 'async_trait>(
    client: &'life0 Client,
    c_ranking: &'life1 ClubRanking
) -> Pin<Box<dyn Future<Output = Result<Club>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait, 

(Async) Fetches a Club using data from a ClubRanking object.

impl Hash for ClubRanking

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for ClubRanking

fn cmp(&self, other: &ClubRanking) -> Ordering

Compares and determines which ClubRanking has a higher rank (i.e., smaller rank number).

Examples

use brawl_api::{ClubLeaderboard, traits::*};


let leaderboard: ClubLeaderboard;


// after fetching the leaderboard (see examples in ClubLeaderboard::fetch)...

let (club_1, club_2) = (&leaderboard[0], &leaderboard[1]);
// generally, the first club is the one with 'rank' field equal to 1 and the second,
// 'rank' field equal to 2, so assume this is true (the API generally sends them sorted,
// but, to guarantee strictness, one can 'leaderboard.sort()'.

assert!(club_1 > club_2)  // smaller rank number = higher position

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ClubRanking> for ClubRanking

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ClubRanking> for ClubRanking

fn partial_cmp(&self, other: &ClubRanking) -> Option<Ordering>

Compares and determines which ClubRanking has a higher rank (i.e., smaller rank number).

Examples

use brawl_api::{ClubLeaderboard, traits::*};


let leaderboard: ClubLeaderboard;


// after fetching the leaderboard (see examples in ClubLeaderboard::fetch)...

let (club_1, club_2) = (&leaderboard[0], &leaderboard[1]);
// generally, the first club is the one with 'rank' field equal to 1 and the second,
// 'rank' field equal to 2, so assume this is true (the API generally sends them sorted,
// but, to guarantee strictness, one can 'leaderboard.sort()'.

assert!(club_1 > club_2)  // smaller rank number = higher position

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ClubRanking

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ClubRanking

impl StructuralPartialEq for ClubRanking