Struct discord_rpc_sdk::RichPresence

pub struct RichPresence {
    pub state: Option<String>,
    pub details: Option<String>,
    pub start_time: Option<SystemTime>,
    pub end_time: Option<SystemTime>,
    pub large_image_key: Option<String>,
    pub large_image_text: Option<String>,
    pub small_image_key: Option<String>,
    pub small_image_text: Option<String>,
    pub party_id: Option<String>,
    pub party_size: Option<u32>,
    pub party_max: Option<u32>,
    pub spectate_secret: Option<String>,
    pub join_secret: Option<String>,
}

Defines the data displayed on the rich presence screen on a user's profile.

Fields

state: Option<String>

The user's current party status. Maximum of 128 bytes.

For example: "Looking to Play", "Playing Solo", "In a Group"...

details: Option<String>

What the player is currently doing. Maximum of 128 bytes.

For example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP"...

start_time: Option<SystemTime>

Time of game start. Including will show time as "elapsed".

end_time: Option<SystemTime>

Time of game end. Including will show time as "remaining".

large_image_key: Option<String>

Name of the uploaded image for the large profile artwork. Maximum of 32 bytes.

large_image_text: Option<String>

Tooltip for the large image. Maximum of 128 bytes.

small_image_key: Option<String>

Name of the uploaded image for the large profile artwork. Maximum of 32 bytes.

small_image_text: Option<String>

Tooltip for the large image. Maximum of 128 bytes.

party_id: Option<String>

ID of the player's party, lobby, or group. Maximum of 128 bytes.

party_size: Option<u32>

Current size of the player's party, lobby, or group.

party_max: Option<u32>

Maximum size of the player's party, lobby, or group.

spectate_secret: Option<String>

Unique hashed string for Spectate button. Maximum of 128 bytes.

join_secret: Option<String>

Unique hashed string for chat invitations and Ask to Join. Maximum of 128 bytes.

Trait Implementations

impl Default for RichPresence

fn default() -> RichPresence

Returns the "default value" for a type.

impl Clone for RichPresence

fn clone(&self) -> RichPresence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for RichPresence

fn hash<__H: Hasher>(&self, __arg_0: &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 for RichPresence

fn eq(&self, __arg_0: &RichPresence) -> bool

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

fn ne(&self, __arg_0: &RichPresence) -> bool

This method tests for !=.

impl Debug for RichPresence

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

Formats the value using the given formatter.