Struct DiscordIPC 

pub struct DiscordIPC { /* private fields */ }

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

Implementations

impl DiscordIPC

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

Examples found in repository

examples/indefinite.rs (line 6)

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

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

    let handle = client.run().await?; // spawns IPC loop; this enforces tokio workflow
    client.set_activity("this runs", "forever").await?; // set activity
    handle.await??;

    Ok(())
}

examples/timed.rs (line 9)

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

    // first run
    let handle = 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.close().await?;
    handle.await??; // wait for closing

    // 2nd run
    client.run().await?;

    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

The Discord client ID that has been used to initialize this IPC client instance.

Examples found in repository

examples/indefinite.rs (line 8)

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

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

    let handle = client.run().await?; // spawns IPC loop; this enforces tokio workflow
    client.set_activity("this runs", "forever").await?; // set activity
    handle.await??;

    Ok(())
}

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

Run the client. Returns a JoinHandle<anyhow::Result<()>> for management. NOTE: Must be called before any .set_activity() calls.

Examples found in repository

examples/indefinite.rs (line 10)

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

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

    let handle = client.run().await?; // spawns IPC loop; this enforces tokio workflow
    client.set_activity("this runs", "forever").await?; // set activity
    handle.await??;

    Ok(())
}

examples/timed.rs (line 12)

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

    // first run
    let handle = 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.close().await?;
    handle.await??; // wait for closing

    // 2nd run
    client.run().await?;

    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 set_activity(&self, details: &str, state: &str) -> Result<()>

Sets/updates the Discord Rich presence activity. NOTE: .run() must be executed prior to calling this.

Examples found in repository

examples/indefinite.rs (line 11)

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

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

    let handle = client.run().await?; // spawns IPC loop; this enforces tokio workflow
    client.set_activity("this runs", "forever").await?; // set activity
    handle.await??;

    Ok(())
}

examples/timed.rs (line 14)

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

    // first run
    let handle = 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.close().await?;
    handle.await??; // wait for closing

    // 2nd run
    client.run().await?;

    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(&self) -> Result<()>

Closes the current session of Rich Presence activity.

Examples found in repository

examples/timed.rs (line 19)

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

    // first run
    let handle = 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.close().await?;
    handle.await??; // wait for closing

    // 2nd run
    client.run().await?;

    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(())
}

Trait Implementations

impl Clone for DiscordIPC

fn clone(&self) -> DiscordIPC

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiscordIPC

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

Formats the value using the given formatter.