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
|
use std::default::Default;
use ::client::rest;
pub struct Configuration {
#[doc(hidden)]
pub depth: usize,
#[doc(hidden)]
pub on_mention: Option<Vec<String>>,
#[doc(hidden)]
pub allow_whitespace: bool,
#[doc(hidden)]
pub prefix: Option<String>,
}
impl Configuration {
/// The default depth of the message to check for commands. Defaults to 5.
/// This determines how "far" into a message to check for a valid command.
///
/// # Examples
///
/// If you set a depth of `1`, and make a command of `"music play"`, but
/// not a `"music"` command, then the former command will never be
/// triggered, as its "depth" is `2`.
pub fn depth(mut self, depth: u8) -> Self {
self.depth = depth as usize;
self
}
/// Whether or not to respond to commands initiated with a mention. Note
/// that this can be used in conjunction with [`prefix`].
///
/// By default this is set to `false`.
///
/// # Examples
///
/// Setting this to `true` will allow the following types of mentions to be
/// responded to:
///
/// ```ignore
/// <@245571012924538880> about
/// <@!245571012924538880> about
/// ```
///
/// The former is a direct mention, while the latter is a nickname mention,
/// which aids mobile devices in determining whether to display a user's
/// nickname. It has no real meaning for your bot, and the library
/// encourages you to ignore differentiating between the two.
///
/// [`prefix`]: #method.prefix
pub fn on_mention(mut self, on_mention: bool) -> Self {
if !on_mention {
return self;
}
if let Ok(current_user) = rest::get_current_user() {
self.on_mention = Some(vec![
format!("<@{}>", current_user.id), // Regular mention
format!("<@!{}>", current_user.id), // Nickname mention
]);
}
self
}
/// Whether to allow whitespace being optional between a mention/prefix and
/// a command.
///
/// **Note**: Defaults to `false`.
///
/// # Examples
///
/// Setting this to `false` will _only_ allow this scenario to occur:
///
/// ```ignore
/// <@245571012924538880> about
/// !about
///
/// // bot processes and executes the "about" command if it exists
/// ```
///
/// while setting this to `true` will _also_ allow this scenario to occur:
///
/// ```ignore
/// <@245571012924538880>about
/// ! about
///
/// // bot processes and executes the "about" command if it exists
/// ```
pub fn allow_whitespace(mut self, allow_whitespace: bool)
-> Self {
self.allow_whitespace = allow_whitespace;
self
}
/// Sets the prefix to respond to. This can either be a single-char or
/// multi-char string.
pub fn prefix<S: Into<String>>(mut self, prefix: S) -> Self {
self.prefix = Some(prefix.into());
self
}
}
impl Default for Configuration {
/// Builds a default framework configuration, setting the following:
///
/// - **allow_whitespace** to `false`
/// - **depth** to `5`
/// - **on_mention** to `false` (basically)
/// - **prefix** to `None`
fn default() -> Configuration {
Configuration {
depth: 5,
on_mention: None,
allow_whitespace: false,
prefix: None,
}
}
}
|