Struct DiscordIPC 

pub struct DiscordIPC { /* private fields */ }

Basic Discord rich presence IPC implementation. See the docs: https://docs.rs/crate/filthy-rich/latest

Implementations

impl DiscordIPC

pub async fn new_from(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 8)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

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

    Ok(())
}

examples/timed.rs (line 11)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

    client.run().await?;

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

    Ok(())
}

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

Bare-bones implementation of handshake with the Discord IPC. Use .run() instead.

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

Look out for READY in socket frames. Use .run() instead.

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

Convenience function for performing handshake, waiting for READY opcode and handling the IPC response loop.

Examples found in repository

examples/indefinite.rs (line 10)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

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

    Ok(())
}

examples/timed.rs (line 13)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

    client.run().await?;

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

    Ok(())
}

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

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

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

    Ok(())
}

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

Sets a tiny Discord rich presence activity.

Examples found in repository

examples/indefinite.rs (line 11)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

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

    Ok(())
}

examples/timed.rs (line 15)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new_from("1463450870480900160").await?;

    client.run().await?;

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

    Ok(())
}