Struct discord_game_sdk::Activity

pub struct Activity(_);

Activity (also known as Rich Presence)

https://discordapp.com/developers/docs/game-sdk/activities#data-models-activity-struct

Methods

impl Activity

pub fn empty() -> Self

Create a new Activity with empty fields

pub fn is_empty(&self) -> bool

Check if an Activity is completely blank and should be ignored

pub fn kind(&self) -> ActivityKind

pub fn application_id(&self) -> i64

pub fn name(&self) -> &str

Cost

String length is calculated every call

pub fn state(&self) -> &str

Cost

String length is calculated every call

pub fn details(&self) -> &str

Cost

String length is calculated every call

pub fn start_time(&self) -> DateTime<Utc>

pub fn end_time(&self) -> DateTime<Utc>

pub fn large_image_key(&self) -> &str

Cost

String length is calculated every call

pub fn large_image_tooltip(&self) -> &str

Cost

String length is calculated every call

pub fn small_image_key(&self) -> &str

Cost

String length is calculated every call

pub fn small_image_tooltip(&self) -> &str

Cost

String length is calculated every call

pub fn party_id(&self) -> &str

Cost

String length is calculated every call

pub fn party_amount(&self) -> i32

pub fn party_capacity(&self) -> i32

pub fn instance(&self) -> bool

pub fn match_secret(&self) -> &str

Cost

String length is calculated every call

pub fn join_secret(&self) -> &str

Cost

String length is calculated every call

pub fn spectate_secret(&self) -> &str

Cost

String length is calculated every call

pub fn with_state(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_details(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_start_time(&mut self, value: DateTime<Utc>) -> &mut Self

pub fn with_end_time(&mut self, value: DateTime<Utc>) -> &mut Self

pub fn with_large_image_key(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_large_image_tooltip(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_small_image_key(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_small_image_tooltip(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_party_id(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_party_amount(&mut self, value: i32) -> &mut Self

pub fn with_party_capacity(&mut self, value: i32) -> &mut Self

pub fn with_instance(&mut self, value: bool) -> &mut Self

pub fn with_match_secret(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_join_secret(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

pub fn with_spectate_secret(&mut self, value: impl AsRef<CStr>) -> &mut Self

value must be valid UTF-8

Panics

value must be smaller than the container it is being written to

Trait Implementations

impl Copy for Activity

impl Clone for Activity

fn clone(&self) -> Activity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Activity> for Activity

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

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

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

This method tests for !=.

impl From<DiscordActivity> for Activity

fn from(original: DiscordActivity) -> Activity

Performs the conversion.

impl From<Activity> for DiscordActivity

fn from(original: Activity) -> DiscordActivity

Performs the conversion.

impl Eq for Activity

impl Debug for Activity

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

Formats the value using the given formatter.