[−][src]Struct brawl_api::model::clubs::ClubMember
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
[src]
fn clone(&self) -> ClubMember
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for ClubMember
[src]
impl Default for ClubMember
[src]
fn default() -> ClubMember
[src]
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
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for ClubMember
[src]
impl FetchFrom<ClubMember> for Player
[src]
fn fetch_from(client: &Client, member: &ClubMember) -> Result<Player>
[src]
(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,
[src]
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
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for ClubMember
[src]
fn cmp(&self, other: &ClubMember) -> Ordering
[src]
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
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<ClubMember> for ClubMember
[src]
fn eq(&self, other: &ClubMember) -> bool
[src]
fn ne(&self, other: &ClubMember) -> bool
[src]
impl PartialOrd<ClubMember> for ClubMember
[src]
fn partial_cmp(&self, other: &ClubMember) -> Option<Ordering>
[src]
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
1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Serialize for ClubMember
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for ClubMember
[src]
impl StructuralPartialEq for ClubMember
[src]
Auto Trait Implementations
impl RefUnwindSafe for ClubMember
impl Send for ClubMember
impl Sync for ClubMember
impl Unpin for ClubMember
impl UnwindSafe for ClubMember
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
fn equivalent(&self, key: &K) -> bool
[src]
impl<T> FetchFrom<T> for T where
T: Clone + Send + Sync,
[src]
T: Clone + Send + Sync,
fn fetch_from(&Client, &T) -> Result<T, Error>
[src]
(Sync) Returns a copy of the current instance when attempting to fetch from itself.
In order to re-fetch, see Refetchable
.
Errors
Never errors; is only a Result
in order to match the trait signature.
fn a_fetch_from<'life0, 'life1, 'async_trait>(
&'life0 Client,
&'life1 T
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + 'async_trait + Send>> where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
[src]
&'life0 Client,
&'life1 T
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + 'async_trait + Send>> where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
(Async) Returns a copy of the current instance when attempting to fetch from itself.
In order to re-fetch, see Refetchable
.
Errors
Never errors; is only a Result
in order to match the trait signature.
impl<T, U> FetchInto<U> for T where
T: Sync + Send,
U: FetchFrom<T> + Sync + Send,
[src]
T: Sync + Send,
U: FetchFrom<T> + Sync + Send,
fn fetch_into(&Self, &Client) -> Result<U, Error>
[src]
fn a_fetch_into<'life0, 'life1, 'async_trait>(
&'life0 Self,
&'life1 Client
) -> Pin<Box<dyn Future<Output = Result<U, Error>> + 'async_trait + Send>> where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
U: 'async_trait,
[src]
&'life0 Self,
&'life1 Client
) -> Pin<Box<dyn Future<Output = Result<U, Error>> + 'async_trait + Send>> where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
U: 'async_trait,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,