Skip to main content

filthy_rich/
lib.rs

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