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.

7 files changed, 20 insertions, 9 deletions

diff --git a/src/model/channel/attachment.rs b/src/model/channel/attachment.rs
index 4d72f58..f520cd4 100644
--- a/src/model/channel/attachment.rs
+++ b/src/model/channel/attachment.rs
@@ -91,7 +91,9 @@ impl Attachment {
     ///     }
     /// }
     /// let token = env::var("DISCORD_TOKEN").expect("token in environment");
-    /// let mut client = Client::new(&token, Handler); client.start().unwrap();
+    /// let mut client = Client::new(&token, Handler).unwrap();
+    ///
+    /// client.start().unwrap();
     /// ```
     ///
     /// # Errors
diff --git a/src/model/channel/guild_channel.rs b/src/model/channel/guild_channel.rs
index 3f09bd7..8fc9abb 100644
--- a/src/model/channel/guild_channel.rs
+++ b/src/model/channel/guild_channel.rs
@@ -442,7 +442,9 @@ impl GuildChannel {
     ///         println!("The user's permissions: {:?}", permissions);
     ///     }
     /// }
-    /// let mut client = Client::new("token", Handler); client.start().unwrap();
+    /// let mut client = Client::new("token", Handler).unwrap();
+    ///
+    /// client.start().unwrap();
     /// ```
     ///
     /// Check if the current user has the [Attach Files] and [Send Messages]
@@ -488,7 +490,9 @@ impl GuildChannel {
     ///     }
     /// }
     ///
-    /// let mut client = Client::new("token", Handler); client.start().unwrap();
+    /// let mut client = Client::new("token", Handler).unwrap();
+    ///
+    /// client.start().unwrap();
     /// ```
     ///
     /// # Errors
diff --git a/src/model/channel/message.rs b/src/model/channel/message.rs
index b5864fc..984e274 100644
--- a/src/model/channel/message.rs
+++ b/src/model/channel/message.rs
@@ -88,7 +88,7 @@ impl Message {
     /// #   struct Handler;
     /// #
     /// #   impl EventHandler for Handler {}
-    /// #   let mut client = Client::new("token", Handler);
+    /// #   let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::model::Channel;
     /// use serenity::framework::StandardFramework;
diff --git a/src/model/error.rs b/src/model/error.rs
index a66095a..835678a 100644
--- a/src/model/error.rs
+++ b/src/model/error.rs
@@ -47,7 +47,9 @@ use super::Permissions;
 ///     }
 /// }
 /// let token = env::var("DISCORD_BOT_TOKEN")?;
-/// let mut client = Client::new(&token, Handler); client.start()?;
+/// let mut client = Client::new(&token, Handler).unwrap();
+///
+/// client.start()?;
 /// #     Ok(())
 /// # }
 /// #
diff --git a/src/model/guild/mod.rs b/src/model/guild/mod.rs
index 7582180..8483e75 100644
--- a/src/model/guild/mod.rs
+++ b/src/model/guild/mod.rs
@@ -1320,7 +1320,7 @@ impl Guild {
     ///     }
     /// }
     ///
-    /// let mut client = Client::new("token", Handler);
+    /// let mut client = Client::new("token", Handler).unwrap();
     ///
     /// client.start().unwrap();
     /// ```
diff --git a/src/model/guild/partial_guild.rs b/src/model/guild/partial_guild.rs
index bdfcbe0..c4181fd 100644
--- a/src/model/guild/partial_guild.rs
+++ b/src/model/guild/partial_guild.rs
@@ -464,7 +464,7 @@ impl PartialGuild {
     ///     }
     /// }
     ///
-    /// let mut client = Client::new("token", Handler);
+    /// let mut client = Client::new("token", Handler).unwrap();
     ///
     /// client.start().unwrap();
     /// ```
diff --git a/src/model/user.rs b/src/model/user.rs
index bf247f1..7eea83e 100644
--- a/src/model/user.rs
+++ b/src/model/user.rs
@@ -634,7 +634,8 @@ impl User {
     ///         // normal message handling here
     ///     }
     /// }
-    /// let mut client = Client::new("token", Handler);
+    ///
+    /// let mut client = Client::new("token", Handler).unwrap();
     /// #
     /// use serenity::model::UserId;
     /// use serenity::CACHE;
@@ -712,7 +713,9 @@ impl User {
     ///         }
     ///     }
     /// }
-    /// let mut client = Client::new("token", Handler); client.start().unwrap();
+    /// let mut client = Client::new("token", Handler).unwrap();
+    ///
+    /// client.start().unwrap();
     /// ```
     #[inline]
     pub fn tag(&self) -> String { tag(&self.name, self.discriminator) }