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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
//! Serenity is an ergonomic and high-level Rust library for the Discord API.
//!
//! View the [examples] on how to make and structure a bot.
//!
//! Serenity supports both bot and user login via the use of [`Client::login_bot`]
//! and [`Client::login_user`].
//!
//! You may also check your tokens prior to login via the use of
//! [`validate_token`].
//!
//! Once logged in, you may add handlers to your client to dispatch [`Event`]s,
//! such as [`Client::on_message`]. This will cause your handler to be called
//! when a [`Event::MessageCreate`] is received. Each handler is given a
//! [`Context`], giving information about the event. See the
//! [client's module-level documentation].
//!
//! The [`Shard`] is transparently handled by the library, removing
//! unnecessary complexity. Sharded connections are automatically handled for
//! you. See the [gateway's documentation][gateway docs] for more information.
//!
//! A [`Cache`] is also provided for you. This will be updated automatically for
//! you as data is received from the Discord API via events. When calling a
//! method on a [`Context`], the cache will first be searched for relevant data
//! to avoid unnecessary HTTP requests to the Discord API. For more information,
//! see the [cache's module-level documentation][cache docs].
//!
//! Note that, although this documentation will try to be as up-to-date and
//! accurate as possible, Discord hosts [official documentation][docs]. If you
//! need to be sure that some information piece is sanctioned by Discord, refer
//! to their own documentation.
//!
//! # Example Bot
//!
//! A basic ping-pong bot looks like:
//!
//! ```rust,ignore
//! extern crate serenity;
//!
//! use serenity::client::{Client, Context};
//! use serenity::model::Message;
//! use std::env;
//!
//! fn main() {
//! // Login with a bot token from the environment
//! let mut client = Client::login_bot(&env::var("DISCORD_TOKEN").expect("token"));
//! client.with_framework(|f| f
//! .configure(|c| c.prefix("~")) // set the bot's prefix to "~"
//! .on("ping", ping));
//!
//! // start listening for events by starting a single shard
//! let _ = client.start();
//! }
//!
//! fn ping(_context: &Context, message: &Message, _args: Vec<String>) {
//! let _ = message.reply("Pong!");
//! }
//! ```
//!
//! ### Full Examples
//!
//! Full examples, detailing and explaining usage of the basic functionality of the
//! library, can be found in the [`examples`] directory.
//!
//! # Features
//!
//! Features can be enabled or disabled by configuring the library through
//! Cargo.toml:
//!
//! ```toml
//! [dependencies.serenity]
//! git = "https://github.com/zeyla/serenity.rs.git"
//! default-features = false
//! features = ["pick", "your", "feature", "names", "here"]
//! ```
//!
//! The following is a full list of features:
//!
//! - **cache**: The cache will store information about guilds, channels, users,
//! and other data, to avoid performing REST requests. If you are low on RAM, do
//! not enable this;
//! - **framework**: Enables the framework, which is a utility to allow simple
//! command parsing, before/after command execution, prefix setting, and more;
//! - **methods**: Enables compilation of extra methods on struct
//! implementations, such as `Message::delete()`, `Message::reply()`,
//! `Guild::edit()`, and more. Without this enabled, requests will need to go
//! through the [`Context`] or [`rest`] module, which are slightly less
//! efficient from a development standpoint, and do not automatically perform
//! permission checking;
//! - **voice**: Enables compilation of voice support, so that voice channels
//! can be connected to and audio can be sent/received.
//!
//! # Dependencies
//!
//! Serenity requires the following dependencies:
//!
//! - openssl
//!
//! ### Voice
//!
//! The following dependencies all require the **voice** feature to be enabled
//! in your Cargo.toml:
//!
//! - libsodium (Arch: `community/libsodium`)
//! - opus (Arch: `extra/opus`)
//!
//! Voice+ffmpeg:
//!
//! - ffmpeg (Arch: `extra/ffmpeg`)
//!
//! Voice+youtube-dl:
//!
//! - youtube-dl (Arch: `community/youtube-dl`)
//!
//! [`Cache`]: ext/cache/struct.Cache.html
//! [`Client::login_bot`]: client/struct.Client.html#method.login_bot
//! [`Client::login_user`]: client/struct.Client.html#method.login_user
//! [`Client::on_message`]: client/struct.Client.html#method.on_message
//! [`Context`]: client/struct.Context.html
//! [`Event`]: model/event/enum.Event.html
//! [`Event::MessageCreate`]: model/event/enum.Event.html#variant.MessageCreate
//! [`Shard`]: client/struct.Shard.html
//! [`examples`]: https://github.com/zeyla/serenity.rs.git/blob/master/examples
//! [`rest`]: client/rest/index.html
//! [`validate_token`]: client/fn.validate_token.html
//! [cache docs]: ext/cache/index.html
//! [client's module-level documentation]: client/index.html
//! [docs]: https://discordapp.com/developers/docs/intro
//! [examples]: https://github.com/zeyla/serenity.rs/tree/master/examples
//! [gateway docs]: client/gateway/index.html
#![allow(doc_markdown, inline_always, unknown_lints)]
#![doc(html_logo_url = "https://docs.austinhellyer.me/serenity.rs/docs_header.png")]
#![warn(enum_glob_use, if_not_else)]
#[macro_use]
extern crate bitflags;
#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate log;
extern crate base64;
extern crate byteorder;
extern crate flate2;
extern crate hyper;
extern crate multipart;
extern crate serde_json;
extern crate time;
extern crate websocket;
#[cfg(feature="voice")]
extern crate opus;
#[cfg(feature="voice")]
extern crate sodiumoxide;
#[macro_use]
pub mod utils;
pub mod client;
pub mod ext;
pub mod model;
pub mod prelude;
mod constants;
mod error;
mod internal;
pub use client::Client;
pub use error::{Error, Result};
|