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")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    client.run(true).await?;

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

    Ok(())
}

examples/timed.rs (line 9)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    // first run
    client.run(true).await?;

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

    client.close().await?;
    sleep(Duration::from_secs(5)).await;

    client.run(true).await?;

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

    Ok(())
}

pub fn on_ready<F: Fn() + Send + 'static>(self, f: F) -> Self

Run a particular closure after receiving the READY event from the local Discord IPC server.

Examples found in repository

examples/indefinite.rs (line 7)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    client.run(true).await?;

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

    Ok(())
}

examples/timed.rs (line 10)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    // first run
    client.run(true).await?;

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

    client.close().await?;
    sleep(Duration::from_secs(5)).await;

    client.run(true).await?;

    client
        .set_activity("this runs".to_string(), Some("for ten seconds".to_string()))
        .await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("believe it".to_string(), Some("or not!".to_string()))
        .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.

pub async fn run(&mut self, wait_for_ready: bool) -> Result<()>

Run the client. Must be called before any DiscordIPC::set_activity calls.

Examples found in repository

examples/indefinite.rs (line 9)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    client.run(true).await?;

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

    Ok(())
}

examples/timed.rs (line 13)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    // first run
    client.run(true).await?;

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

    client.close().await?;
    sleep(Duration::from_secs(5)).await;

    client.run(true).await?;

    client
        .set_activity("this runs".to_string(), Some("for ten seconds".to_string()))
        .await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("believe it".to_string(), Some("or not!".to_string()))
        .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 14)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    client.run(true).await?;

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

    Ok(())
}

pub fn is_running(&self) -> bool

Checks whether the task is running through the internal atomic indicator flag.

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

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

Examples found in repository

examples/indefinite.rs (line 12)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    client.run(true).await?;

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

    Ok(())
}

examples/timed.rs (line 16)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    // first run
    client.run(true).await?;

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

    client.close().await?;
    sleep(Duration::from_secs(5)).await;

    client.run(true).await?;

    client
        .set_activity("this runs".to_string(), Some("for ten seconds".to_string()))
        .await?;
    sleep(Duration::from_secs(5)).await;
    client
        .set_activity("believe it".to_string(), Some("or not!".to_string()))
        .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 connection if any.

Examples found in repository

examples/timed.rs (line 24)

async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|| println!("filthy-rich is READY to set activities."));

    // first run
    client.run(true).await?;

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

    client.close().await?;
    sleep(Duration::from_secs(5)).await;

    client.run(true).await?;

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

    Ok(())
}