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
|
pub use ext::framework::command::{Command, CommandType};
use std::collections::HashMap;
use std::default::Default;
use std::sync::Arc;
use ::client::Context;
use ::model::Message;
pub struct CreateCommand(pub Command);
impl CreateCommand {
/// Adds a "check" to a command, which checks whether or not the command's
/// function should be called.
///
/// # Examples
///
/// Ensure that the user who created a message, calling a "ping" command,
/// is the owner.
///
/// ```rust,no_run
/// use serenity::client::{Client, Context};
/// use serenity::model::Message;
/// use std::env;
///
/// let mut client = Client::login_bot(&env::var("DISCORD_TOKEN").unwrap());
///
/// client.with_framework(|f| f
/// .configure(|c| c.prefix("~"))
/// .command("ping", |c| c
/// .check(owner_check)
/// .desc("Replies to a ping with a pong")
/// .exec(ping)));
///
/// fn ping(context: &Context, _message: &Message, _args: Vec<String>) {
/// context.say("Pong!");
/// }
///
/// fn owner_check(_context: &Context, message: &Message) -> bool {
/// // replace with your user ID
/// message.author.id == 7
/// }
/// ```
pub fn check<F>(mut self, check: F) -> Self
where F: Fn(&Context, &Message) -> bool + Send + Sync + 'static {
self.0.checks.push(Box::new(check));
self
}
/// Description, used by other commands.
pub fn desc(mut self, desc: &str) -> Self {
self.0.desc = Some(desc.to_owned());
self
}
/// A function that can be called when a command is received.
///
/// See [`exec_str`] if you _only_ need to return a string on command use.
///
/// [`exec_str`]: #method.exec_str
pub fn exec<F>(mut self, func: F) -> Self
where F: Fn(&Context, &Message, Vec<String>) + Send + Sync + 'static {
self.0.exec = CommandType::Basic(Box::new(func));
self
}
/// Sets a function that's called when a command is called that can access
/// the internal HashMap of usages, used specifically for creating a help
/// command.
pub fn exec_help<F>(mut self, f: F) -> Self
where F: Fn(&Context, &Message, HashMap<String, Arc<Command>>, Vec<String>) + Send + Sync + 'static {
self.0.exec = CommandType::WithCommands(Box::new(f));
self
}
/// Sets a string to be sent in the channel of context on command. This can
/// be useful for an `about`, `invite`, `ping`, etc. command.
///
/// # Examples
///
/// Create a command named "ping" that returns "Pong!":
///
/// ```rust,ignore
/// client.with_framework(|f| f
/// .command("ping", |c| c.exec_str("Pong!")));
/// ```
pub fn exec_str(mut self, content: &str) -> Self {
self.0.exec = CommandType::StringResponse(content.to_owned());
self
}
/// Command usage schema, used by other commands.
pub fn usage(mut self, usage: &str) -> Self {
self.0.usage = Some(usage.to_owned());
self
}
/// Whether or not arguments should be parsed using the quotation parser.
///
/// Enabling this will parse `~command "this is arg 1" "this is arg 2"` as
/// two arguments: `this is arg 1` and `this is arg 2`.
///
/// Disabling this will parse `~command "this is arg 1" "this is arg 2"` as
/// eight arguments: `"this`, `is`, `arg`, `1"`, `"this`, `is`, `arg`, `2"`.
///
/// Refer to [`utils::parse_quotes`] for information on the parser.
///
/// [`utils::parse_quotes`]: ../../utils/fn.parse_quotes.html
pub fn use_quotes(mut self, use_quotes: bool) -> Self {
self.0.use_quotes = use_quotes;
self
}
}
impl Default for Command {
fn default() -> Command {
Command {
checks: Vec::default(),
exec: CommandType::Basic(Box::new(|_, _, _| {})),
desc: None,
usage: None,
use_quotes: true,
}
}
}
|