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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
use super::command::{
Help,
HelpOptions,
HelpFunction
};
pub use super::{
Args,
CommandGroup,
CommandOptions,
CommandError,
HelpBehaviour
};
use utils::Colour;
use std::{
fmt::Write,
sync::Arc
};
pub struct CreateHelpCommand(pub HelpOptions, pub HelpFunction);
impl CreateHelpCommand {
/// Sets a message displaying if input could not be found
/// but a similar command is available.
///
/// **Note**: `{}` will be substituted with the actual suggested command-name.
/// Hence no `{}` results in no command-name.
pub fn suggestion_text(mut self, text: &str) -> Self {
self.0.suggestion_text = text.to_string();
self
}
/// Sets a message displaying if there is no help available.
pub fn no_help_available_text(mut self, text: &str) -> Self {
self.0.no_help_available_text = text.to_string();
self
}
/// Sets a label for usage of a command.
pub fn usage_label(mut self, text: &str) -> Self {
self.0.usage_label = text.to_string();
self
}
/// Sets a label for the usage examples of a command.
pub fn usage_sample_label(mut self, text: &str) -> Self {
self.0.usage_sample_label = text.to_string();
self
}
/// Sets a label for ungrouped-commands
pub fn ungrouped_label(mut self, text: &str) -> Self {
self.0.ungrouped_label = text.to_string();
self
}
/// Sets a label for grouped-commands.
pub fn grouped_label(mut self, text: &str) -> Self {
self.0.grouped_label = text.to_string();
self
}
/// Sets a label for aliases.
pub fn aliases_label(mut self, text: &str) -> Self {
self.0.aliases_label = text.to_string();
self
}
/// Sets a message displaying if a command is only available
/// in guilds.
pub fn guild_only_text(mut self, text: &str) -> Self {
self.0.guild_only_text = text.to_string();
self
}
/// Sets a message displaying if a command is only available
/// in direct messages (DMs);
pub fn dm_only_text(mut self, text: &str) -> Self {
self.0.dm_only_text = text.to_string();
self
}
/// Sets a message displaying if a command is available in
/// guilds and DMs.
pub fn dm_and_guilds_text(mut self, text: &str) -> Self {
self.0.dm_and_guild_text = text.to_string();
self
}
/// Sets a message displaying if a command is available to use.
pub fn available_text(mut self, text: &str) -> Self {
self.0.available_text = text.to_string();
self
}
/// Sets a message that will appear upon failing to find
/// an individual command.
/// As in: `{prefix}help {command_name}`, but a command or
/// alias like `{command_name}` does not exist.
///
/// **Note**: `{}` will be substituted with the actual suggested command-name.
/// Hence no `{}` results in no command-name.
pub fn command_not_found_text(mut self, text: &str) -> Self {
self.0.command_not_found_text = text.to_string();
self
}
/// Sets the message on top of the help-menu, informing the
/// user how to obtain more information about a single command.
pub fn individual_command_tip(mut self, text: &str) -> Self {
self.0.individual_command_tip = text.to_string();
self
}
/// Sets how the group-prexix shall be labeled.
pub fn group_prefix(mut self, text: &str) -> Self {
self.0.group_prefix = text.to_string();
self
}
/// Sets how a command requiring roles, that a user is lacking,
/// shall appear in the help-menu.
pub fn lacking_role(mut self, behaviour: HelpBehaviour) -> Self {
self.0.lacking_role = behaviour;
self
}
/// Sets how a command requiring permission, that a user is lacking,
/// shall be appear in the help-menu.
pub fn lacking_permissions(mut self, behaviour: HelpBehaviour) -> Self {
self.0.lacking_permissions = behaviour;
self
}
/// Sets how a command requiring to be sent in either via DM
/// or a guild should be treated in the help-menu.
pub fn wrong_channel(mut self, behaviour: HelpBehaviour) -> Self {
self.0.wrong_channel = behaviour;
self
}
/// Sets the tip (or legend) explaining why some commands are striked,
/// given text will be used in guilds and direct messages.
///
/// By default this is `Some(String)` and the `String` is empty resulting
/// in an automated substitution based on your `HelpBehaviour`-settings.
/// If set to `None`, no tip will be given nor will it be substituted.
/// If set to a non-empty `Some(String)`, the `String` will be displayed as tip.
///
/// **Note**: [`CreateHelpCommand::striked_commands_tip_in_direct_message`] and
/// [`CreateHelpCommand::striked_commands_tip_in_guild`] can specifically set this text
/// for direct messages and guilds.
///
/// [`CreateHelpCommand::striked_commands_tip_in_direct_message`]: #method.striked_commands_tip_in_direct_message
/// [`CreateHelpCommand::striked_commands_tip_in_guild`]: #method.striked_commands_tip_in_guild
pub fn striked_commands_tip(mut self, text: Option<String>) -> Self {
self.0.striked_commands_tip_in_dm = text.clone();
self.0.striked_commands_tip_in_guild = text;
self
}
/// Sets the tip (or legend) explaining why some commands are striked,
/// given text will be used in guilds.
///
/// By default this is `Some(String)` and the `String` is empty resulting
/// in an automated substitution based on your `HelpBehaviour`-settings.
/// If set to `None`, no tip will be given nor will it be substituted.
/// If set to a non-empty `Some(String)`, the `String` will be displayed as tip.
pub fn striked_commands_tip_in_guild(mut self, text: Option<String>) -> Self {
self.0.striked_commands_tip_in_guild = text;
self
}
/// Sets the tip (or legend) explaining why some commands are striked,
/// given text will be used in direct messages.
///
/// By default this is `Some(String)` and the `String` is empty resulting
/// in an automated substitution based on your `HelpBehaviour`-settings.
/// If set to `None`, no tip will be given nor will it be substituted.
/// If set to a non-empty `Some(String)`, the `String` will be displayed as tip.
pub fn striked_commands_tip_in_direct_message(mut self, text: Option<String>) -> Self {
self.0.striked_commands_tip_in_dm = text;
self
}
/// Sets the colour for the embed if no error occured.
pub fn embed_success_colour(mut self, colour: Colour) -> Self {
self.0.embed_success_colour = colour;
self
}
/// Sets the colour for the embed if an error occured.
pub fn embed_error_colour(mut self, colour: Colour) -> Self {
self.0.embed_error_colour = colour;
self
}
fn produce_strike_text(&self, dm_or_guild: &str) -> Option<String> {
let mut strike_text = String::from("~~`Strikethrough commands`~~ are unavailable because they");
let mut is_any_option_strike = false;
let mut concat_with_comma = if self.0.lacking_permissions == HelpBehaviour::Strike {
is_any_option_strike = true;
let _ = write!(strike_text, " require permissions");
true
} else {
false
};
if self.0.lacking_role == HelpBehaviour::Strike {
is_any_option_strike = true;
if concat_with_comma {
let _ = write!(strike_text, ", require a specific role");
} else {
let _ = write!(strike_text, " require a specific role");
concat_with_comma = true;
}
}
if self.0.wrong_channel == HelpBehaviour::Strike {
is_any_option_strike = true;
if concat_with_comma {
strike_text.push_str(&format!(", or are limited to {}", dm_or_guild));
} else {
strike_text.push_str(&format!(" are limited to {}", dm_or_guild));
}
}
let _ = write!(strike_text, ".");
if is_any_option_strike {
Some(strike_text)
} else {
None
}
}
/// Finishes the creation of a help-command, returning `Help`.
/// If `Some(String)` was set as `striked_commands_tip` and the `String` is empty,
/// the creator will substitute content based on the `HelpBehaviour`-settings.
pub(crate) fn finish(mut self) -> Arc<Help> {
if self.0.striked_commands_tip_in_dm == Some(String::new()) {
self.0.striked_commands_tip_in_dm = self.produce_strike_text("direct messages");
}
if self.0.striked_commands_tip_in_guild == Some(String::new()) {
self.0.striked_commands_tip_in_guild = self.produce_strike_text("guild messages");
}
let CreateHelpCommand(options, function) = self;
Arc::new(Help(function, Arc::new(options)))
}
}