Struct brawl_api::model::clubs::ClubMember

pub struct ClubMember {
    pub tag: String,
    pub name: String,
    pub trophies: usize,
    pub role: ClubMemberRole,
    pub name_color: u64,
}

A struct representing a Brawl Stars club's member, with its club-relevant data (most importantly, its role). Use Player::fetch_from to fetch the full player data.

Fields

tag: String

The member's tag.

name: String

The member's name.

trophies: usize

The member's trophies.

role: ClubMemberRole

The member's role in the guild. (Default is ClubMemberRole::Member)

name_color: u64

The member's name color, as an integer (Default is 0xffffff = 16777215 - this is used when the data is not available).

Trait Implementations

impl Clone for ClubMember

fn clone(&self) -> ClubMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClubMember

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

Formats the value using the given formatter.

impl Default for ClubMember

fn default() -> ClubMember

Returns an instance of ClubMember with initial values.

Examples

use brawl_api::model::{ClubMember, ClubMemberRole};

assert_eq!(
    ClubMember::default(),
    ClubMember {
        tag: String::from(""),
        name: String::from(""),
        trophies: 0,
        role: ClubMemberRole::default(),
        name_color: 0xff_ff_ff
    }
);

impl<'de> Deserialize<'de> for ClubMember

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

Deserialize this value from the given Serde deserializer.

impl Eq for ClubMember

impl FetchFrom<ClubMember> for Player

fn fetch_from(client: &Client, member: &ClubMember) -> Result<Player>

(Sync) Fetches a Player instance, given a preexisting ClubMember instance.

Errors

See Player::fetch.

Examples

use brawl_api::{Client, Player, Club, traits::*};

let my_client = Client::new("my auth token");
let club = Club::fetch(&my_client, "#CLUB_TAG_HERE")?;
let some_member = &club.members[0];
let some_player = Player::fetch_from(&my_client, some_member)?;
// now `some_member`'s full data, as a Player, is available for use.

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

(Async) Fetches a Player instance, given a preexisting ClubMember instance.

Errors

See Player::fetch.

Examples

use brawl_api::{Client, Player, Club, traits::*};

let my_client = Client::new("my auth token");
let club = Club::a_fetch(&my_client, "#CLUB_TAG_HERE").await?;
let some_member = &club.members[0];
let some_player = Player::a_fetch_from(&my_client, some_member).await?;
// now `some_member`'s full data, as a Player, is available for use.

impl Hash for ClubMember

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 ClubMember

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

Compares and determines which ClubMember has a higher role.

Examples

(NOTE: Club members are not meant to be initialized, but rather obtained from a fetched Club instance. They are only instantiated here for this example.)

use brawl_api::{ClubMember, ClubMemberRole};

let member_1 = ClubMember { role: ClubMemberRole::Member, ..ClubMember::default() };
let member_2 = ClubMember { role: ClubMemberRole::VicePresident, ..ClubMember::default() };

assert!(member_1 < member_2)  // vice-president has more power than a normal Member

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<ClubMember> for ClubMember

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

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

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

This method tests for !=.

impl PartialOrd<ClubMember> for ClubMember

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

Compares and determines which ClubMember has a higher role.

Examples

(NOTE: Club members are not meant to be initialized, but rather obtained from a fetched Club instance. They are only instantiated here for this example.)

use brawl_api::{ClubMember, ClubMemberRole};

let member_1 = ClubMember { role: ClubMemberRole::Member, ..ClubMember::default() };
let member_2 = ClubMember { role: ClubMemberRole::VicePresident, ..ClubMember::default() };

assert!(member_1 < member_2)  // vice-president has more power than a normal Member

#[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 ClubMember

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 ClubMember

impl StructuralPartialEq for ClubMember