Struct brawl_api::model::clubs::Club

pub struct Club {
    pub tag: String,
    pub name: String,
    pub description: Option<String>,
    pub trophies: usize,
    pub required_trophies: usize,
    pub members: ClubMembers,
    pub club_type: ClubType,
}

A struct representing a Brawl Stars club, with all of its data. Use Club::fetch to fetch one based on tag.

Fields

tag: String

The club's tag. Note: this includes the initial '#'.

name: String

The club's name.

description: Option<String>

The club's description.

trophies: usize

The club's trophies.

required_trophies: usize

The amount of trophies required to enter on this club, or 0 if it allows any amount.

members: ClubMembers

The members in this club, as a vector of ClubMember (note that the ClubMembers struct is simply a smart pointer for Vec<ClubMember>).

club_type: ClubType

The type of club (see ClubType docs).

Trait Implementations

impl Clone for Club

fn clone(&self) -> Club

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Club

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

Formats the value using the given formatter.

impl Default for Club

fn default() -> Club

Returns an instance of Club with initial values.

Examples

use brawl_api::{Club, ClubType, ClubMembers};

assert_eq!(
    Club::default(),
    Club {
        tag: String::from(""),
        name: String::from(""),
        description: None,
        trophies: 0,
        required_trophies: 0,
        members: ClubMembers::default(),
        club_type: ClubType::Open,
    }
);

impl<'de> Deserialize<'de> for Club

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

Deserialize this value from the given Serde deserializer.

impl Eq for Club

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 FetchFrom<PlayerClub> for Club

fn fetch_from(client: &Client, p_club: &PlayerClub) -> Result<Club>

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

fn a_fetch_from<'life0, 'life1, 'async_trait>(
    client: &'life0 Client,
    p_club: &'life1 PlayerClub
) -> 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 PlayerClub object.

impl<'_> From<&'_ Club> for ClubMembers

fn from(club: &Club) -> ClubMembers

Simply returns a given Club's members field, while cloning.

impl<'a> From<&'a Club> for &'a ClubMembers

fn from(club: &'a Club) -> Self

Simply returns a given Club's members field.

impl From<Club> for ClubMembers

fn from(club: Club) -> ClubMembers

Simply returns a given Club's members field.

impl GetFetchProp for Club

type Property = str

fn get_fetch_prop(&self) -> &str

Obtain the revelant property for fetching.

fn get_route(tag: &str) -> Route

Obtain the route for fetching by using a property.

impl Hash for Club

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 PartialEq<Club> for Club

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

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

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

This method tests for !=.

impl PropFetchable for Club

type Property = str

fn fetch(client: &Client, tag: &str) -> Result<Club>

(Sync) Fetches a club from its tag.

Errors

This function may error:

• While requesting (will return an Error::Request);
• After receiving a bad status code (API or other error - returns an Error::Status);
• After a ratelimit is indicated by the API, while also specifying when it is lifted (Error::Ratelimited);
• While parsing incoming JSON (will return an Error::Json).

(All of those, of course, wrapped inside an Err.)

Examples

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

let my_client = Client::new("my auth token");
let club = Club::fetch(&my_client, "#CLUBTAGHERE")?;
// now the data for the given club is available for use.

fn a_fetch<'life0, 'async_trait>(
    client: &'life0 Client,
    tag: &'async_trait str
) -> Pin<Box<dyn Future<Output = Result<Club>> + Send + 'async_trait>> where
    Self: 'async_trait,
    Self::Property: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

(Async) Fetches a club from its tag.

Errors

This function may error:

• While requesting (will return an Error::Request);
• After receiving a bad status code (API or other error - returns an Error::Status);
• After a ratelimit is indicated by the API, while also specifying when it is lifted (Error::Ratelimited);
• While parsing incoming JSON (will return an Error::Json).

(All of those, of course, wrapped inside an Err.)

Examples

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

let my_client = Client::new("my auth token");
let club = Club::a_fetch(&my_client, "#CLUBTAGHERE").await?;
// now the data for the given club is available for use.

impl Serialize for Club

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 Club

impl StructuralPartialEq for Club