Struct DiscordIPCSync 

pub struct DiscordIPCSync { /* private fields */ }

Implementations

impl DiscordIPCSync

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

Creates a new Discord IPC client instance.

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

pub fn client_id(&self) -> String

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

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

Run the 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));
}

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

Waits for the IPC task to finish. [run()] must be called to spawn it in the first place.

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 executed 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));
}

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

Clears a previously set Discord Rich Presence activity.

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

Closes the current session of Rich Presence activity.

Trait Implementations

impl Debug for DiscordIPCSync

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

Formats the value using the given formatter.

impl Drop for DiscordIPCSync

fn drop(&mut self)

Executes the destructor for this type.