Enum volt::user::UserResult

pub enum UserResult {
    User(User),
    UserFlags(UserFlags),
    UserProfile(UserProfile),
    String(String),
}

The enum for data returning

The variations of this enum are the types that are returned after .run() is called

Note!:

If any of the methods that impliment this enum are called the type will change

Variants

User(User)

UserFlags(UserFlags)

UserProfile(UserProfile)

String(String)

Implementations

impl UserResult

pub fn id(&self) -> String

Returns a users id

Returns:

The users id as a string

Panics!:

This funtion will panic if the enum variant UserResult::User has not been called

pub fn name(&self) -> String

Returns a users name

Returns:

The users name as a string

Panics!:

This funtion will panic if the enum variant UserResult::User has not been called

pub fn avatar(&self) -> Image

Returns a users avatar

Returns:

The users avatar data in the form of a struct called image that can be parsed down to get the specific values

Panics!:

This funtion will panic if the enum variant UserResult::User has not been called

pub fn badges(&self) -> Vec<&str>

Returns the badges a users has

Badges can be earned on Revolt for different things (will explain below)

The API shows badges as the sum of the values of all the badges

Badge Values:

• 1: Developer (Develops Revolt)
• 2: Translator (Translated Revolt into another language)
• 4: Supporter (Supported Revolt with a donation)
• 8: Responsibly Disclosed Bug(s) (Disclosed a bug responibly)
• 16: Founder (Founded Revolt)
• 32: Platform Moderation (Moderates Revolt)
• 64: Active Supporter (Activlty supports Revolt)
• 128: Paw (🦊🦝)
• 256: Early Adopter (One of the first 1000 users)
• 512: ReservedRelevantJokeBadge1 (Amogus)
• 1024 ReservedRelevantJokeBadge2 (Amogus Troll Face)

Returns

A vec<&str> of the badges the user has earned in order from highest value to lowest value

Panics!:

This funtion will panic if the enum variant UserResult::User has not been called

pub fn flags(&self) -> usize

Returns the users flags

Flags are information about the users account status on revolt

• 1: Suspended
• 2: Deleted
• 4: Banned

Returns:

The users flags as a usize

Panics!:

This function will panic if fetch_user_flags() was not called

pub fn background(&self) -> Image

Returns a users background image

Returns:

The users background data in the form of a struct called image that can be parsed down to get the specific values

Panics!:

This funtion will panic if the enum variant UserResult::UserProfile has not been called

pub fn status(&self) -> String

Returns the status text of a user

Returns:

The status text of a user as a string

Note:

This function takes both UserResult::UserProfile and UserResult::User

When UserResult::User is called the value may be “None” if there was no status or there was and error parsing the status

Panics!:

This function will panic if fetch_user_flags was called before

Trait Implementations

impl Clone for UserResult

fn clone(&self) -> UserResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserResult

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<UserResult> for UserResult

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UserResult

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserResult