Make the Client return a Result

The client now returns a Result in preparation of a future commit.

Upgrade path:

Handle the case of an error via pattern matching, or unwrap the Result.

4 files changed, 30 insertions, 26 deletions

diff --git a/src/framework/standard/configuration.rs b/src/framework/standard/configuration.rs
index 8cc25fa..6cb5767 100644
--- a/src/framework/standard/configuration.rs
+++ b/src/framework/standard/configuration.rs
@@ -20,11 +20,13 @@ use model::{GuildId, Message, UserId};
 /// struct Handler;
 ///
 /// impl EventHandler for Handler {}
+///
 /// use serenity::Client;
 /// use std::env;
 /// use serenity::framework::StandardFramework;
 ///
-/// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap(), Handler);
+/// let token = env::var("DISCORD_BOT_TOKEN").unwrap();
+/// let mut client = Client::new(&token, Handler).unwrap();
 ///
 /// client.with_framework(StandardFramework::new()
 ///     .configure(|c| c.on_mention(true).prefix("~")));
@@ -98,7 +100,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::model::GuildId;
     /// use serenity::framework::StandardFramework;
     ///
@@ -123,7 +125,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::model::UserId;
     /// use serenity::framework::StandardFramework;
     ///
@@ -161,7 +163,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::framework::StandardFramework;
     ///
     /// let disabled = vec!["ping"].into_iter().map(|x| x.to_string()).collect();
@@ -191,7 +193,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::framework::StandardFramework;
     ///
     /// client.with_framework(StandardFramework::new()
@@ -276,7 +278,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::model::UserId;
     /// use serenity::framework::StandardFramework;
     ///
@@ -291,7 +293,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::model::UserId;
     /// use std::collections::HashSet;
     /// use serenity::framework::StandardFramework;
@@ -320,7 +322,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -345,7 +347,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -369,7 +371,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -394,7 +396,7 @@ impl Configuration {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
diff --git a/src/framework/standard/create_command.rs b/src/framework/standard/create_command.rs
index e4665e8..c1558ce 100644
--- a/src/framework/standard/create_command.rs
+++ b/src/framework/standard/create_command.rs
@@ -47,7 +47,8 @@ impl CreateCommand {
     /// use std::env;
     /// use std::sync::Arc;
     ///
-    /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap(), Handler);
+    /// let token = env::var("DISCORD_TOKEN").unwrap();
+    /// let mut client = Client::new(&token, Handler).unwrap();
     ///
     /// client.with_framework(StandardFramework::new()
     ///     .configure(|c| c.prefix("~"))
@@ -117,7 +118,7 @@ impl CreateCommand {
     /// command.
     ///
     /// You can return `Err(From::from(string))` if there's an error.
-    pub fn exec_help(mut self, f: 
+    pub fn exec_help(mut self, f:
                     fn(&mut Context, &Message, HashMap<String, Arc<CommandGroup>>, Args)
                     -> Result<(), CommandError>) -> Self {
         self.0.exec = CommandType::WithCommands(f);
diff --git a/src/framework/standard/help_commands.rs b/src/framework/standard/help_commands.rs
index ef7732b..56d096e 100644
--- a/src/framework/standard/help_commands.rs
+++ b/src/framework/standard/help_commands.rs
@@ -83,7 +83,7 @@ pub fn has_all_requirements(cmd: &Command, msg: &Message) -> bool {
 /// # struct Handler;
 /// #
 /// # impl EventHandler for Handler {}
-/// # let mut client = Client::new("token", Handler);
+/// # let mut client = Client::new("token", Handler).unwrap();
 /// #
 /// use serenity::framework::standard::{StandardFramework, help_commands};
 ///
@@ -255,7 +255,7 @@ pub fn with_embeds(_: &mut Context,
 /// # struct Handler;
 /// #
 /// # impl EventHandler for Handler {}
-/// # let mut client = Client::new("token", Handler);
+/// # let mut client = Client::new("token", Handler).unwrap();
 /// #
 /// use serenity::framework::standard::{StandardFramework, help_commands};
 ///
diff --git a/src/framework/standard/mod.rs b/src/framework/standard/mod.rs
index 36570af..1681bd7 100644
--- a/src/framework/standard/mod.rs
+++ b/src/framework/standard/mod.rs
@@ -143,7 +143,7 @@ use std::fmt;
 impl fmt::Debug for DispatchError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         use self::DispatchError::*;
-        
+
         match *self {
             CheckFailed(..) => write!(f, "DispatchError::CheckFailed"),
             CommandDisabled(ref s) => f.debug_tuple("DispatchError::CommandDisabled").field(&s).finish(),
@@ -218,7 +218,8 @@ impl StandardFramework {
     /// use serenity::framework::StandardFramework;
     /// use std::env;
     ///
-    /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap(), Handler);
+    /// let token = env::var("DISCORD_TOKEN").unwrap();
+    /// let mut client = Client::new(&token, Handler).unwrap();
     /// client.with_framework(StandardFramework::new()
     ///     .configure(|c| c
     ///         .depth(3)
@@ -251,7 +252,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -287,7 +288,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -396,7 +397,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -592,7 +593,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -684,7 +685,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -717,7 +718,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// use serenity::framework::standard::DispatchError::{NotEnoughArguments,
     /// TooManyArguments};
     /// use serenity::framework::StandardFramework;
@@ -758,7 +759,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -776,7 +777,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///
@@ -814,7 +815,7 @@ impl StandardFramework {
     /// # struct Handler;
     /// #
     /// # impl EventHandler for Handler {}
-    /// # let mut client = Client::new("token", Handler);
+    /// # let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::framework::StandardFramework;
     ///