Struct DiscordIPC 

pub struct DiscordIPC { /* private fields */ }

Primary struct for you to set and update Discord Rich Presences with.

Implementations

impl DiscordIPC

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

Creates a new asynchronous Discord IPC client with the given client ID.

Examples found in repository

examples/indefinite.rs (line 6)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

    println!("Performing as client: {}", client.client_id());

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

    Ok(())
}

examples/timed.rs (line 9)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

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

    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;

    client.clear_activity().await?;

    // if you want to drop the connection here:
    // client.close().await?;

    // optional sleep
    sleep(Duration::from_secs(2)).await;

    // if you closed the connection, you must run it afterwards:
    // client.run().await?;

    // 2nd run
    client.set_activity("this is the", "second run").await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("which also runs for", "ten seconds")
        .await?;
    sleep(Duration::from_secs(5)).await;

    Ok(())
}

pub fn client_id(&self) -> String

Returns the Discord client ID that has been used to initialize this IPC client.

Examples found in repository

examples/indefinite.rs (line 8)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

    println!("Performing as client: {}", client.client_id());

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

    Ok(())
}

pub fn is_running(&self) -> bool

Checks internally whether or not an existing IPC client instance is running and currently attached with Discord.

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

Runs the Discord IPC client.

Examples found in repository

examples/indefinite.rs (line 10)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

    println!("Performing as client: {}", client.client_id());

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

    Ok(())
}

examples/timed.rs (line 12)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

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

    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;

    client.clear_activity().await?;

    // if you want to drop the connection here:
    // client.close().await?;

    // optional sleep
    sleep(Duration::from_secs(2)).await;

    // if you closed the connection, you must run it afterwards:
    // client.run().await?;

    // 2nd run
    client.set_activity("this is the", "second run").await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("which also runs for", "ten seconds")
        .await?;
    sleep(Duration::from_secs(5)).await;

    Ok(())
}

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

Waits for the primary IPC client task to finish. Can also be used to keep the IPC client running forever.

Examples found in repository

examples/indefinite.rs (line 12)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

    println!("Performing as client: {}", client.client_id());

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

    Ok(())
}

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

Sets/updates a Discord Rich Presence activity.

Examples found in repository

examples/indefinite.rs (line 11)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

    println!("Performing as client: {}", client.client_id());

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

    Ok(())
}

examples/timed.rs (line 14)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

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

    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;

    client.clear_activity().await?;

    // if you want to drop the connection here:
    // client.close().await?;

    // optional sleep
    sleep(Duration::from_secs(2)).await;

    // if you closed the connection, you must run it afterwards:
    // client.run().await?;

    // 2nd run
    client.set_activity("this is the", "second run").await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("which also runs for", "ten seconds")
        .await?;
    sleep(Duration::from_secs(5)).await;

    Ok(())
}

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

Clears a previously-set Discord Rich Presence activity. Prefer this function over close() if the current process is not being exited with the presence toggle.

Examples found in repository

examples/timed.rs (line 19)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160");

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

    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;

    client.clear_activity().await?;

    // if you want to drop the connection here:
    // client.close().await?;

    // optional sleep
    sleep(Duration::from_secs(2)).await;

    // if you closed the connection, you must run it afterwards:
    // client.run().await?;

    // 2nd run
    client.set_activity("this is the", "second run").await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("which also runs for", "ten seconds")
        .await?;
    sleep(Duration::from_secs(5)).await;

    Ok(())
}

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

Closes the current session of Rich Presence activity.

NOTE: Always try to use one activity per session as Discord might sometimes behave weirdly with session closes; this was only found noticeable if run() and close() were repeatedly called.

Trait Implementations

impl Debug for DiscordIPC

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

Formats the value using the given formatter.