aboutsummaryrefslogtreecommitdiff
path: root/src/framework
diff options
context:
space:
mode:
authoracdenisSK <[email protected]>2017-07-02 14:33:23 +0200
committeracdenisSK <[email protected]>2017-07-02 18:29:29 +0200
commit511ec87280e8ddec6589f48fec8260bf2e598bdb (patch)
tree008846c1531ecd47887abb9623b98a960b1fa808 /src/framework
parentAdd a `quit` function` (diff)
downloadserenity-511ec87280e8ddec6589f48fec8260bf2e598bdb.tar.xz
serenity-511ec87280e8ddec6589f48fec8260bf2e598bdb.zip
Fix doc tests
Diffstat (limited to 'src/framework')
-rw-r--r--src/framework/configuration.rs61
-rw-r--r--src/framework/create_command.rs5
-rw-r--r--src/framework/help_commands.rs12
-rw-r--r--src/framework/mod.rs79
4 files changed, 112 insertions, 45 deletions
diff --git a/src/framework/configuration.rs b/src/framework/configuration.rs
index bb5a20f..16c595f 100644
--- a/src/framework/configuration.rs
+++ b/src/framework/configuration.rs
@@ -16,10 +16,14 @@ use ::model::{GuildId, Message, UserId};
/// Responding to mentions and setting a command prefix of `"~"`:
///
/// ```rust,no_run
+/// # use serenity::prelude::EventHandler;
+/// struct Handler;
+///
+/// impl EventHandler for Handler {}
/// use serenity::Client;
/// use std::env;
///
-/// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap());
+/// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap(), Handler);
///
/// client.with_framework(|f| f
/// .configure(|c| c.on_mention(true).prefix("~")));
@@ -99,8 +103,11 @@ impl Configuration {
/// Create a HashSet in-place:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// use serenity::model::GuildId;
///
/// client.with_framework(|f| f.configure(|c| c
@@ -120,8 +127,11 @@ impl Configuration {
/// Create a HashSet in-place:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// use serenity::model::UserId;
///
/// client.with_framework(|f| f.configure(|c| c
@@ -154,8 +164,11 @@ impl Configuration {
/// Ignore a set of commands, assuming they exist:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
///
/// let disabled = vec!["ping"].into_iter().map(|x| x.to_owned()).collect();
///
@@ -180,9 +193,11 @@ impl Configuration {
/// otherwise return a prefix of `"~"`.
///
/// ```rust,no_run
- /// # use serenity::Client;
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
/// #
- /// # let mut client = Client::new("token");
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// client.with_framework(|f| f
/// .command("ping", |c| c.exec_str("Pong!"))
/// .configure(|c| c.dynamic_prefix(|_, msg| {
@@ -261,8 +276,11 @@ impl Configuration {
/// Create a HashSet in-place:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// use serenity::model::UserId;
///
/// client.with_framework(|f| f.configure(|c| c
@@ -272,8 +290,11 @@ impl Configuration {
/// Create a HashSet beforehand:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// use serenity::model::UserId;
/// use std::collections::HashSet;
///
@@ -297,8 +318,11 @@ impl Configuration {
/// Assign a basic prefix:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f.configure(|c| c
/// .prefix("!")));
@@ -317,8 +341,11 @@ impl Configuration {
/// Assign a set of prefixes the bot can respond to:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f.configure(|c| c
/// .prefixes(vec!["!", ">", "+"])));
diff --git a/src/framework/create_command.rs b/src/framework/create_command.rs
index 9aed52f..abed3ea 100644
--- a/src/framework/create_command.rs
+++ b/src/framework/create_command.rs
@@ -34,11 +34,14 @@ impl CreateCommand {
/// is the owner.
///
/// ```rust,no_run
+ /// # use serenity::prelude::EventHandler;
+ /// # struct Handler;
+ /// # impl EventHandler for Handler {}
/// use serenity::client::{Client, Context};
/// use serenity::model::Message;
/// use std::env;
///
- /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap());
+ /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap(), Handler);
///
/// client.with_framework(|f| f
/// .configure(|c| c.prefix("~"))
diff --git a/src/framework/help_commands.rs b/src/framework/help_commands.rs
index 82fd7bf..a35ce7d 100644
--- a/src/framework/help_commands.rs
+++ b/src/framework/help_commands.rs
@@ -58,9 +58,11 @@ fn remove_aliases(cmds: &HashMap<String, CommandOrAlias>) -> HashMap<&String, &I
/// Use the command with `exec_help`:
///
/// ```rust
-/// # use serenity::Client;
+/// # use serenity::prelude::*;
+/// # struct Handler;
/// #
-/// # let mut client = Client::new("token");
+/// # impl EventHandler for Handler {}
+/// # let mut client = Client::new("token", Handler);
/// #
/// use serenity::ext::framework::help_commands;
///
@@ -208,9 +210,11 @@ pub fn with_embeds(_: &mut Context,
/// Use the command with `exec_help`:
///
/// ```rust
-/// # use serenity::Client;
+/// # use serenity::prelude::*;
+/// # struct Handler;
/// #
-/// # let mut client = Client::new("token");
+/// # impl EventHandler for Handler {}
+/// # let mut client = Client::new("token", Handler);
/// #
/// use serenity::ext::framework::help_commands;
///
diff --git a/src/framework/mod.rs b/src/framework/mod.rs
index aae518b..a521b13 100644
--- a/src/framework/mod.rs
+++ b/src/framework/mod.rs
@@ -243,11 +243,11 @@ pub struct Framework {
/// - a command check has been set.
///
/// This is used internally to determine whether or not - in addition to
- /// dispatching to the [`Client::on_message`] handler - to have the
+ /// dispatching to the [`EventHandler::on_message`] handler - to have the
/// framework check if a [`Event::MessageCreate`] should be processed by
/// itself.
///
- /// [`Client::on_message`]: ../client/struct.Client.html#method.on_message
+ /// [`EventHandler::on_message`]: ../client/event_handler/trait.EventHandler.html#method.on_message
/// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
pub initialized: bool,
user_info: (u64, bool),
@@ -264,10 +264,13 @@ impl Framework {
/// [allowing whitespace], and setting the [`prefix`] to `"~"`:
///
/// ```rust,no_run
+ /// # use serenity::prelude::EventHandler;
+ /// # struct Handler;
+ /// # impl EventHandler for Handler {}
/// use serenity::Client;
/// use std::env;
///
- /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap());
+ /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap(), Handler);
/// client.with_framework(|f| f
/// .configure(|c| c
/// .depth(3)
@@ -296,8 +299,11 @@ impl Framework {
/// a 2 second delay inbetween invocations:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .bucket("basic", 2, 10, 3)
@@ -325,8 +331,11 @@ impl Framework {
/// Create and use a simple bucket that has a 2 second delay between invocations:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .simple_bucket("simple", 2)
@@ -352,10 +361,13 @@ impl Framework {
///
/// # Examples
/// ```rust,no_run
- /// # use serenity::Client;
/// use serenity::model::ReactionType;
/// use serenity::framework::ReactionAction;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .action(ReactionAction::Add(ReactionType::Unicode("❤".to_string())), |_, _, channel_id| {
@@ -374,10 +386,13 @@ impl Framework {
///
/// # Examples
/// ```rust,no_run
- /// # use serenity::Client;
/// use serenity::model::ReactionType;
/// use serenity::framework::ReactionAction;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// let action = ReactionAction::Add(ReactionType::Unicode("❤".to_string()));
/// client.with_framework(|f| f
@@ -649,8 +664,11 @@ impl Framework {
/// # #[macro_use] extern crate serenity;
/// #
/// # fn main() {
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f.on("ping", ping));
///
@@ -727,8 +745,11 @@ impl Framework {
/// Creating a simple group:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .group("ping-pong", |g| g
@@ -755,8 +776,11 @@ impl Framework {
/// Making a simple argument error responder:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// use serenity::framework::DispatchError::{NotEnoughArguments, TooManyArguments};
///
/// client.with_framework(|f| f
@@ -791,8 +815,11 @@ impl Framework {
/// Using `before` to log command usage:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .before(|ctx, msg, cmd_name| {
@@ -804,8 +831,11 @@ impl Framework {
/// Using before to prevent command usage:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .before(|_, msg, cmd_name| {
@@ -837,8 +867,11 @@ impl Framework {
/// Using `after` to log command usage:
///
/// ```rust
- /// # use serenity::Client;
- /// # let mut client = Client::new("token");
+ /// # use serenity::prelude::*;
+ /// # struct Handler;
+ /// #
+ /// # impl EventHandler for Handler {}
+ /// # let mut client = Client::new("token", Handler);
/// #
/// client.with_framework(|f| f
/// .after(|ctx, msg, cmd_name, error| {