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 Discord IPC client instance.

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;

    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");

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

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

    Ok(())
}

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

Run the client. 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");

    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;

    Ok(())
}

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

Waits for the IPC task to finish.

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 the Discord Rich presence activity. [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");

    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;

    Ok(())
}

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

Clears a previously set Discord Rich Presence activity.

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

Closes the current session of Rich Presence activity.

Trait Implementations

impl Debug for DiscordIPC

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

Formats the value using the given formatter.