Skip to main content

DiscordIPCClient

Struct DiscordIPCClient 

Source
pub struct DiscordIPCClient { /* private fields */ }
Expand description

A client handle for controlling Discord IPC.

Implementations§

Source§

impl DiscordIPCClient

Source

pub fn client_id(&self) -> String

Returns the client ID.

Source

pub fn is_running(&self) -> bool

Checks if the task is running.

Source

pub async fn set_activity(&self, activity: Activity) -> Result<(), Error>

Sets/updates the Discord Rich presence activity. The runner must be started before calling this.

Examples found in repository?
examples/simple.rs (line 11)
5async fn main() -> Result<()> {
6    let mut runner = DiscordIPCRunner::new("1463450870480900160");
7
8    let activity = Activity::build_empty();
9
10    let client = runner.run(true).await?;
11    client.set_activity(activity).await?;
12    runner.wait().await?;
13
14    Ok(())
15}
More examples
Hide additional examples
examples/indefinite.rs (line 17)
5async fn main() -> Result<()> {
6    let mut runner = DiscordIPCRunner::new("1463450870480900160")
7        .on_ready(|data| println!("Connected to user: {}", data.user.username));
8
9    let client = runner.run(true).await?;
10
11    let activity = Activity::new()
12        .details("this runs forever")
13        .large_image("game_icon", Some("Playing a game"))
14        .small_image("status", Some("Online"))
15        .build();
16
17    client.set_activity(activity).await?;
18    runner.wait().await?;
19
20    Ok(())
21}
examples/timed.rs (line 31)
8async fn main() -> Result<()> {
9    let mut runner = DiscordIPCRunner::new("1463450870480900160")
10        .on_ready(|data| println!("Connected to user: {}", data.user.username));
11
12    // create activities for later use
13    let activity_1 = Activity::new()
14        .details("this runs")
15        .state("for ten seconds")
16        .build();
17
18    let activity_2 = Activity::new()
19        .details("believe it")
20        .state("or not")
21        .build();
22
23    let closing_activity = Activity::new()
24        .details("closing presence in...")
25        .duration(Duration::from_secs(5))
26        .build();
27
28    // first run
29    let client = runner.run(true).await?;
30
31    client.set_activity(activity_1).await?;
32    sleep(Duration::from_secs(5)).await;
33    client.set_activity(activity_2).await?;
34    sleep(Duration::from_secs(5)).await;
35    client.set_activity(closing_activity).await?;
36    sleep(Duration::from_secs(5)).await;
37
38    Ok(())
39}
Source

pub async fn clear_activity(&self) -> Result<(), Error>

Clears a previously set Discord Rich Presence activity.

Source

pub async fn close(&self) -> Result<(), Error>

Closes the current connection if any.

Trait Implementations§

Source§

impl Clone for DiscordIPCClient

Source§

fn clone(&self) -> DiscordIPCClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DiscordIPCClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.