filthy_rich/lib.rs
1//! This is the API reference page for filthy-rich.
2//!
3//! ## Getting Started
4//!
5//! Please refer to either of these two structs for implementing Rich Presence functionality in your app:
6//!
7//! [`DiscordIPC`] - for async projects.<br>
8//! [`DiscordIPCSync`] - for sync projects.
9//!
10//! ## Examples
11//!
12//! Library examples can be found in [this directory](https://github.com/hitblast/filthy-rich/tree/master/examples) on GitHub.
13
14mod client;
15mod runner;
16pub(crate) mod utils;
17pub use client::DiscordIPCClient;
18pub use runner::DiscordIPCRunner;
19pub use types::{Activity, DiscordUser, ReadyData};
20
21mod socket;
22mod types;