aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-11-01 12:45:21 -0700
committerZeyla Hellyer <[email protected]>2017-11-01 12:45:21 -0700
commitccbc3b348fe41aaad74c7676f1334be246008cae (patch)
tree8a4bf35f5e2220f4ba529d5c0a1b31b8b5c1eac2 /src
parentFix no-parking_lot compilation (diff)
downloadserenity-ccbc3b348fe41aaad74c7676f1334be246008cae.tar.xz
serenity-ccbc3b348fe41aaad74c7676f1334be246008cae.zip
Fix no-client cache tests
There were a few doctests in the cache module that relied on the client module, so instead feature-gate the doctests.
Diffstat (limited to 'src')
-rw-r--r--src/builder/create_embed.rs2
-rw-r--r--src/builder/create_invite.rs10
-rw-r--r--src/cache/mod.rs44
-rw-r--r--src/model/user.rs12
4 files changed, 45 insertions, 23 deletions
diff --git a/src/builder/create_embed.rs b/src/builder/create_embed.rs
index cc5e642..b38984c 100644
--- a/src/builder/create_embed.rs
+++ b/src/builder/create_embed.rs
@@ -248,7 +248,7 @@ impl CreateEmbed {
/// struct Handler;
/// impl EventHandler for Handler {
/// fn on_guild_member_addition(&self, _: Context, guild_id: GuildId, member: Member) {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
/// let cache = CACHE.read().unwrap();
///
/// if let Some(guild) = cache.guild(guild_id) {
diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs
index 5f4f0bf..645d401 100644
--- a/src/builder/create_invite.rs
+++ b/src/builder/create_invite.rs
@@ -19,7 +19,7 @@ use internal::prelude::*;
///
/// impl EventHandler for Handler {
/// fn on_message(&self, _: Context, msg: Message) {
-/// use serenity::client::CACHE;
+/// use serenity::CACHE;
/// if msg.content == "!createinvite" {
/// let channel = match CACHE.read().unwrap().guild_channel(msg.channel_id) {
/// Some(channel) => channel,
@@ -72,7 +72,7 @@ impl CreateInvite {
/// Create an invite with a max age of `3600` seconds, or 1 hour:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// # use serenity::model::ChannelId;
/// # use std::error::Error;
/// #
@@ -106,7 +106,7 @@ impl CreateInvite {
/// Create an invite with a max use limit of `5`:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// # use serenity::model::ChannelId;
/// # use std::error::Error;
/// #
@@ -138,7 +138,7 @@ impl CreateInvite {
/// Create an invite which is temporary:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// # use serenity::model::ChannelId;
/// # use std::error::Error;
/// #
@@ -170,7 +170,7 @@ impl CreateInvite {
/// Create an invite which is unique:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// # use serenity::model::ChannelId;
/// # use std::error::Error;
/// #
diff --git a/src/cache/mod.rs b/src/cache/mod.rs
index 921e77b..357092f 100644
--- a/src/cache/mod.rs
+++ b/src/cache/mod.rs
@@ -169,7 +169,9 @@ impl Cache {
/// # use serenity::prelude::*;
/// # use serenity::model::*;
/// #
- /// use serenity::client::CACHE;
+ /// # #[cfg(feature = "client")]
+ /// # fn main() {
+ /// use serenity::CACHE;
/// use std::thread;
/// use std::time::Duration;
///
@@ -193,6 +195,10 @@ impl Cache {
/// }
///
/// let mut client = Client::new("token", Handler); client.start().unwrap();
+ /// # }
+ /// #
+ /// # #[cfg(not(feature = "client"))]
+ /// # fn main() { }
/// ```
///
/// [`Member`]: ../model/struct.Member.html
@@ -225,7 +231,7 @@ impl Cache {
/// Printing the count of all private channels and groups:
///
/// ```rust,no_run
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let amount = CACHE.read().unwrap().all_private_channels().len();
///
@@ -252,10 +258,12 @@ impl Cache {
/// Print all of the Ids of guilds in the Cache:
///
/// ```rust,no_run
+ /// # #[cfg(feature = "client")]
+ /// # fn main() {
/// # use serenity::prelude::*;
/// # use serenity::model::*;
/// #
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// struct Handler;
/// impl EventHandler for Handler {
@@ -264,6 +272,10 @@ impl Cache {
/// }
/// }
/// let mut client = Client::new("token", Handler);
+ /// # }
+ /// #
+ /// # #[cfg(not(feature = "client"))]
+ /// # fn main() { }
/// ```
///
/// [`Context`]: ../client/struct.Context.html
@@ -330,7 +342,7 @@ impl Cache {
/// # use std::error::Error;
/// #
/// # fn try_main() -> Result<(), Box<Error>> {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let cache = CACHE.read()?;
///
@@ -361,10 +373,12 @@ impl Cache {
/// [`Client::on_message`] event dispatch:
///
/// ```rust,no_run
+ /// # #[cfg(feature = "client")]
+ /// # fn main() {
/// # use serenity::prelude::*;
/// # use serenity::model::*;
/// #
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// struct Handler;
///
@@ -387,6 +401,10 @@ impl Cache {
/// }
///
/// let mut client = Client::new("token", Handler); client.start().unwrap();
+ /// # }
+ /// #
+ /// # #[cfg(not(feature = "client"))]
+ /// # fn main() { }
/// ```
///
/// [`ChannelId`]: ../model/struct.ChannelId.html
@@ -415,7 +433,7 @@ impl Cache {
/// # use std::error::Error;
/// #
/// # fn try_main() -> Result<(), Box<Error>> {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let cache = CACHE.read()?;
///
@@ -494,18 +512,22 @@ impl Cache {
///
/// # Examples
///
- /// Retrieve a private channel from the cache and send a message:
+ /// Retrieve a private channel from the cache and print its recipient's
+ /// name:
///
/// ```rust,no_run
/// # use std::error::Error;
/// #
/// # fn try_main() -> Result<(), Box<Error>> {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let cache = CACHE.read()?;
///
/// if let Some(channel) = cache.private_channel(7) {
- /// channel.read().unwrap().say("Hello there!");
+ /// let channel_reader = channel.read().unwrap();
+ /// let user_reader = channel_reader.recipient.read().unwrap();
+ ///
+ /// println!("The recipient is {}", user_reader.name);
/// }
/// # Ok(())
/// # }
@@ -537,7 +559,7 @@ impl Cache {
/// # use std::error::Error;
/// #
/// # fn try_main() -> Result<(), Box<Error>> {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let cache = CACHE.read()?;
///
@@ -574,7 +596,7 @@ impl Cache {
/// # use std::error::Error;
/// #
/// # fn try_main() -> Result<(), Box<Error>> {
- /// use serenity::client::CACHE;
+ /// use serenity::CACHE;
///
/// let cache = CACHE.read()?;
///
diff --git a/src/model/user.rs b/src/model/user.rs
index 3d39759..bf725cc 100644
--- a/src/model/user.rs
+++ b/src/model/user.rs
@@ -44,7 +44,7 @@ impl CurrentUser {
/// Print out the current user's avatar url if one is set:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let cache = CACHE.read().unwrap();
/// #
@@ -121,7 +121,7 @@ impl CurrentUser {
/// Print out the names of all guilds the current user is in:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let cache = CACHE.read().unwrap();
/// #
@@ -149,7 +149,7 @@ impl CurrentUser {
/// Get the invite url with no permissions set:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let mut cache = CACHE.write().unwrap();
///
@@ -172,7 +172,7 @@ impl CurrentUser {
/// Get the invite url with some basic permissions set:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let mut cache = CACHE.write().unwrap();
///
@@ -228,7 +228,7 @@ impl CurrentUser {
/// Print out the current user's static avatar url if one is set:
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let cache = CACHE.read().unwrap();
/// #
@@ -252,7 +252,7 @@ impl CurrentUser {
/// Print out the current user's distinct identifier (e.g., Username#1234):
///
/// ```rust,no_run
- /// # use serenity::client::CACHE;
+ /// # use serenity::CACHE;
/// #
/// # let cache = CACHE.read().unwrap();
/// #