1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! SmallD aims to be a minmalist client for the Discord API. It aims to let you use the Discord
//! API, without hiding or abstracting it.
//!
//! SmallD takes care of the essentials of interacting with the Discord API, providing a small
//! and flexible core to be built upon. As it does not aim to hide the Discord API working with
//! SmallD will also require an understanding of Discord's API. As such it's usually helpful to
//! keep the [Discord Dev Docs](https://discord.com/developers/docs/intro) in mind.
//!
//! An example of what's in scope for SmallD:
//!   * Authentication (Identifying/Resuming)
//!   * Rate limiting
//!   * Handling disconnections/reconnects
//!
//! Examples of what is not in scope for SmallD:
//!   * Caching
//!   * Command Framework
//!
//! # Getting Started
//!
//! After you have [created a new
//! project](https://doc.rust-lang.org/cargo/guide/creating-a-new-project.html)
//! add smalld_rust as a dependency.
//!
//! ```toml
//! [dependencies]
//! smalld_rust = "*"
//! ```
//!
//! To use SmallD create a SmallD instance and call [`run`](smalld::SmallD#method.run) to connect to
//! Discord.
//!
//! ```no_run
//! use smalld::SmallD;
//!
//! let smalld = SmallD::new().expect("Failed to initialize smalld");
//!
//! // this will block and run until a fatal error or smalld.close() is called
//! smalld.run();
//! ```
//!
//! By default this will look for your Discord token in the `SMALLD_TOKEN` environment variable.
//! It's possible to explicitly provide the token and other configuration options when using
//! [`SmallDBuilder`](smalld::SmallDBuilder).
//!
//! ```no_run
//! use smalld::{Intent, SmallDBuilder};
//!
//! let smalld = SmallDBuilder::new()
//!   .token("my_discord_token")
//!   .intents(Intent::GuildMessages | Intent::DirectMessages)
//!   .build()
//!   .expect("Failed to initialize smalld");
//!
//! smalld.run();
//! ```
//!
//! To listen to events from Discord use the [`on_event`](smalld::SmallD#method.on_event) method,
//! or for all gateway payloads use
//! [`on_gateway_payload`](smalld::SmallD#method.on_gateway_payload), and attach a listener.
//! Each listener receives a reference to [`SmallD`](smalld::SmallD) and the json
//! [`Value`](https://docs.serde.rs/serde_json/value/enum.Value.html) associated with that event.
//!
//! ```no_run
//! use smalld::SmallD;
//!
//! let smalld = SmallD::new().expect("Failed to initialize smalld");
//!
//! smalld.on_event("MESSAGE_CREATE", |smalld, json| {
//!   if let Some("ping") = json.get("content").and_then(|c| c.as_str()) {
//!     println!("Ping Received!");
//!   }
//! });
//!
//! smalld.run();
//! ```
//!   
//! To send requests through Discord's resources api SmallD provides methods related to the HTTP
//! methods. For example, [`post`](smalld::SmallD#method.post) for sending a HTTP post request.
//! We can use this method to send a request to the [create
//! message](https://discord.com/developers/docs/resources/channel#create-message) endpoint.
//!
//! For example, we could add the following method to send a pong response for the above example.
//!
//! ```no_run
//! # use smalld::{SmallD, Error};
//! # use serde_json::{json, Value};
//! pub fn send_pong(smalld: &SmallD, reply_to: Value) -> Result<(), Error> {
//!   if let Some(channel_id) = reply_to.get("channel_id").and_then(|c| c.as_str()) {
//!     smalld.post(
//!         format!("/channels/{}/msesages", channel_id),
//!         json!({"content" : "pong"}))?;
//!   };
//!
//!   Ok(())
//! }
//! ```

pub use crate::error::Error;
pub use crate::http::QueryParameters;
pub use crate::intents::Intent;
pub use crate::payload::{Op, Payload};
pub use crate::smalld::{SmallD, SmallDBuilder};

mod error;
mod gateway;
mod heartbeat;
mod http;
mod identify;
mod intents;
mod listeners;
mod payload;
mod retry;
mod smalld;