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//! [`PresenceRunner`] - core runner for rich presence<br>
8//! [`PresenceClient`] - client/messenger instance used for sending activity and closing updates
9//!
10//! Extra types are stored in the `types` module whereas the error enums and their variants are in the `errors` module respectively.
11//!
12//! ## Looking for Discord's documentation?
13//!
14//! The groundwork of this project has been done using the official [Discord RPC documentation](https://docs.discord.com/developers/topics/rpc)
15//! page. Do note that not all features are/will be implemented as most of them are not fully implemented in Discord itself on a client basis.
16//!
17//! ## Examples
18//!
19//! Library examples can be found in [this directory](https://github.com/hitblast/filthy-rich/tree/master/examples) on GitHub.
20
21mod client;
22mod macros;
23mod runner;
24mod socket;
25mod utils;
26
27pub use client::PresenceClient;
28pub use runner::PresenceRunner;
29
30pub mod errors;
31pub mod types;