Struct DiscordIPC 

pub struct DiscordIPC { /* private fields */ }

Basic Discord rich presence IPC implementation.

Implementations

impl DiscordIPC

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 5)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();
    client.set_activity("this runs", "forever").await.unwrap();
    client.wait().await.unwrap();
}

examples/timed.rs (line 8)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();

    client
        .set_activity("this runs", "for ten seconds")
        .await
        .unwrap();
    sleep(Duration::from_secs(5)).await;
    client.set_activity("believe it", "or not").await.unwrap();
    sleep(Duration::from_secs(5)).await;
}

pub async fn run(&mut self) -> 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 7)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();
    client.set_activity("this runs", "forever").await.unwrap();
    client.wait().await.unwrap();
}

examples/timed.rs (line 10)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();

    client
        .set_activity("this runs", "for ten seconds")
        .await
        .unwrap();
    sleep(Duration::from_secs(5)).await;
    client.set_activity("believe it", "or not").await.unwrap();
    sleep(Duration::from_secs(5)).await;
}

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

Waits for response from IPC task; can be used to run the client indefinitely.

Examples found in repository

examples/indefinite.rs (line 9)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();
    client.set_activity("this runs", "forever").await.unwrap();
    client.wait().await.unwrap();
}

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 8)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();
    client.set_activity("this runs", "forever").await.unwrap();
    client.wait().await.unwrap();
}

examples/timed.rs (line 13)

async fn main() {
    let mut client = DiscordIPC::new("1463450870480900160").await.unwrap();

    client.run().await.unwrap();

    client
        .set_activity("this runs", "for ten seconds")
        .await
        .unwrap();
    sleep(Duration::from_secs(5)).await;
    client.set_activity("believe it", "or not").await.unwrap();
    sleep(Duration::from_secs(5)).await;
}

Trait Implementations

impl Debug for DiscordIPC

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

Formats the value using the given formatter.