aboutsummaryrefslogtreecommitdiff
path: root/src/framework/create_group.rs
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-08-19 09:36:15 -0700
committerZeyla Hellyer <[email protected]>2017-08-19 09:39:44 -0700
commit948b27ce74e8dce458d427d8159f2a821d4d7cec (patch)
treebf82bedd1821ca210e4a9f08644581486738aed6 /src/framework/create_group.rs
parentAdd html_root_url (diff)
downloadserenity-948b27ce74e8dce458d427d8159f2a821d4d7cec.tar.xz
serenity-948b27ce74e8dce458d427d8159f2a821d4d7cec.zip
Move builtin framework impl to its own module
The framework is now moved in its entirity to the `framework` module, with the `Framework` trait currently on its own and the builtin implementation provided. The builtin implementation has been renamed to "Standard". Upgrade path: Rename the `BuiltinFramework` import to `StandardFramework`. Instead of importing builtin framework items from `serenity::framework`, import them from `serenity::framework::standard`. This is the beginning to #60. The root `framework` module (non-standard implementation) will be built more by the time it's closed.
Diffstat (limited to 'src/framework/create_group.rs')
-rw-r--r--src/framework/create_group.rs86
1 files changed, 0 insertions, 86 deletions
diff --git a/src/framework/create_group.rs b/src/framework/create_group.rs
deleted file mode 100644
index b45c41e..0000000
--- a/src/framework/create_group.rs
+++ /dev/null
@@ -1,86 +0,0 @@
-pub use super::command::{Command, CommandGroup, CommandType};
-pub(crate) use super::command::CommandOrAlias;
-pub use super::create_command::CreateCommand;
-
-use std::default::Default;
-use std::sync::Arc;
-use client::Context;
-use model::Message;
-
-/// Used to create command groups
-///
-/// # Examples
-///
-/// Create group named Information where all commands are prefixed with info,
-/// and add one command named "name". For example, if prefix is "~", we say "~info name"
-/// to call the "name" command.
-///
-/// ```rust,ignore
-/// framework.group("Information", |g| g
-/// .prefix("info")
-/// .command("name", |c| c
-/// .exec_str("Hakase")))
-/// ```
-#[derive(Default)]
-pub struct CreateGroup(pub CommandGroup);
-
-impl CreateGroup {
- /// Adds a command to group.
- pub fn command<F>(mut self, command_name: &str, f: F) -> Self
- where F: FnOnce(CreateCommand) -> CreateCommand {
- let cmd = f(CreateCommand(Command::default())).0;
-
- for n in &cmd.aliases {
- if let Some(ref prefix) = self.0.prefix {
- self.0.commands.insert(
- format!("{} {}", prefix, n.to_owned()),
- CommandOrAlias::Alias(
- format!("{} {}", prefix, command_name.to_string()),
- ),
- );
- } else {
- self.0.commands.insert(
- n.to_owned(),
- CommandOrAlias::Alias(command_name.to_string()),
- );
- }
- }
-
- self.0.commands.insert(
- command_name.to_owned(),
- CommandOrAlias::Command(Arc::new(cmd)),
- );
-
- self
- }
-
- /// Adds a command to group with simplified API.
- /// You can return Err(string) if there's an error.
- pub fn on<F>(mut self, command_name: &str, f: F) -> Self
- where F: Fn(&mut Context, &Message, Vec<String>, String) -> Result<(), String>
- + Send
- + Sync
- + 'static {
- let cmd = Arc::new(Command::new(f));
-
- self.0.commands.insert(
- command_name.to_owned(),
- CommandOrAlias::Command(cmd),
- );
-
- self
- }
-
- /// If prefix is set, it will be required before all command names.
- /// For example, if bot prefix is "~" and group prefix is "image"
- /// we'd call a subcommand named "hibiki" by sending "~image hibiki".
- ///
- /// **Note**: serenity automatically puts a space after group prefix.
- ///
- /// **Note**: It's suggested to call this first when making a group.
- pub fn prefix(mut self, desc: &str) -> Self {
- self.0.prefix = Some(desc.to_owned());
-
- self
- }
-}