Struct DiscordIPC

Source

pub struct DiscordIPC { /* private fields */ }

Expand description

Basic Discord rich presence IPC implementation.

Implementations§

Source §

impl DiscordIPC

Source

pub async fn new(client_id: &str) -> Result<Self>

Given a client ID, create a new DiscordIPC instance. Needs to have Discord running for successful execution.

Examples found in repository ?

examples/indefinite.rs (line 6)

5async fn main() -> Result<()> {
6    let mut client = DiscordIPC::new("1463450870480900160").await?;
7
8    let handle = client.run().await?; // spawns IPC loop
9    client.set_activity("this runs", "forever").await?; // set activity
10
11    handle.await??; // wait indefinitely, propagate errors
12
13    Ok(())
14}

More examples

Hide additional examples

examples/timed.rs (line 8)

7async fn main() {
8    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();
9
10    client.run().await.unwrap();
11
12    client
13        .set_activity("this runs", "for ten seconds")
14        .await
15        .unwrap();
16    sleep(Duration::from_secs(5)).await;
17    client.set_activity("believe it", "or not").await.unwrap();
18    sleep(Duration::from_secs(5)).await;
19}

Source

pub async fn run(&mut self) -> Result<JoinHandle<Result<()>>>

Starts off the connection with Discord. This includes performing a handshake, waiting for READY and starting the IPC response loop.

Examples found in repository ?

examples/indefinite.rs (line 8)

5async fn main() -> Result<()> {
6    let mut client = DiscordIPC::new("1463450870480900160").await?;
7
8    let handle = client.run().await?; // spawns IPC loop
9    client.set_activity("this runs", "forever").await?; // set activity
10
11    handle.await??; // wait indefinitely, propagate errors
12
13    Ok(())
14}

More examples

Hide additional examples

examples/timed.rs (line 10)

7async fn main() {
8    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();
9
10    client.run().await.unwrap();
11
12    client
13        .set_activity("this runs", "for ten seconds")
14        .await
15        .unwrap();
16    sleep(Duration::from_secs(5)).await;
17    client.set_activity("believe it", "or not").await.unwrap();
18    sleep(Duration::from_secs(5)).await;
19}

Source

pub async fn set_activity(&mut self, details: &str, state: &str) -> Result<()>

Sets a tiny Discord rich presence activity.

Examples found in repository ?

examples/indefinite.rs (line 9)

5async fn main() -> Result<()> {
6    let mut client = DiscordIPC::new("1463450870480900160").await?;
7
8    let handle = client.run().await?; // spawns IPC loop
9    client.set_activity("this runs", "forever").await?; // set activity
10
11    handle.await??; // wait indefinitely, propagate errors
12
13    Ok(())
14}

More examples

Hide additional examples

examples/timed.rs (line 13)

7async fn main() {
8    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();
9
10    client.run().await.unwrap();
11
12    client
13        .set_activity("this runs", "for ten seconds")
14        .await
15        .unwrap();
16    sleep(Duration::from_secs(5)).await;
17    client.set_activity("believe it", "or not").await.unwrap();
18    sleep(Duration::from_secs(5)).await;
19}