Struct DiscordIPCSync 

pub struct DiscordIPCSync { /* private fields */ }

Synchronous wrapper around DiscordIPC for use in non-async contexts. All operations block on an internal Tokio runtime.

Implementations

impl DiscordIPCSync

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

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

Examples found in repository

examples/indefinite-sync.rs (line 4)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

    client.run().unwrap();
    client.set_activity("this runs", "forever").unwrap();
    client.wait().unwrap();
}

examples/timed-sync.rs (line 6)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

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

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

    client.clear_activity().unwrap();

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

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

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

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

pub fn client_id(&self) -> String

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

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

Run the IPC client. Must be called before any set_activity() calls.

Examples found in repository

examples/indefinite-sync.rs (line 6)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

    client.run().unwrap();
    client.set_activity("this runs", "forever").unwrap();
    client.wait().unwrap();
}

examples/timed-sync.rs (line 9)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

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

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

    client.clear_activity().unwrap();

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

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

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

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

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

Waits for the primary IPC task to finish.

Examples found in repository

examples/indefinite-sync.rs (line 8)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

    client.run().unwrap();
    client.set_activity("this runs", "forever").unwrap();
    client.wait().unwrap();
}

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

Sets/updates the Discord Rich Presence activity. run() must be called prior to calling this.

Examples found in repository

examples/indefinite-sync.rs (line 7)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

    client.run().unwrap();
    client.set_activity("this runs", "forever").unwrap();
    client.wait().unwrap();
}

examples/timed-sync.rs (line 11)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

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

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

    client.clear_activity().unwrap();

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

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

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

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

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

Clears the current Discord Rich Presence activity without closing the session.

Examples found in repository

examples/timed-sync.rs (line 16)

fn main() {
    let mut client = DiscordIPCSync::new("1463450870480900160").unwrap();

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

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

    client.clear_activity().unwrap();

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

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

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

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

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

Closes the current session of Rich Presence activity. After this, you can safely call run() again.

Trait Implementations

impl Debug for DiscordIPCSync

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

Formats the value using the given formatter.