Skip to content

Commit ccbc3b3

Browse files
author
Zeyla Hellyer
committed
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.
1 parent 1d632f7 commit ccbc3b3

File tree

4 files changed

+45
-23
lines changed

4 files changed

+45
-23
lines changed

‎src/builder/create_embed.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ impl CreateEmbed {
248248
/// struct Handler;
249249
/// impl EventHandler for Handler {
250250
/// fn on_guild_member_addition(&self, _: Context, guild_id: GuildId, member: Member) {
251-
/// use serenity::client::CACHE;
251+
/// use serenity::CACHE;
252252
/// let cache = CACHE.read().unwrap();
253253
///
254254
/// if let Some(guild) = cache.guild(guild_id) {

‎src/builder/create_invite.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use internal::prelude::*;
1919
///
2020
/// impl EventHandler for Handler {
2121
/// fn on_message(&self, _: Context, msg: Message) {
22-
/// use serenity::client::CACHE;
22+
/// use serenity::CACHE;
2323
/// if msg.content == "!createinvite" {
2424
/// let channel = match CACHE.read().unwrap().guild_channel(msg.channel_id) {
2525
/// Some(channel) => channel,
@@ -72,7 +72,7 @@ impl CreateInvite {
7272
/// Create an invite with a max age of `3600` seconds, or 1 hour:
7373
///
7474
/// ```rust,no_run
75-
/// # use serenity::client::CACHE;
75+
/// # use serenity::CACHE;
7676
/// # use serenity::model::ChannelId;
7777
/// # use std::error::Error;
7878
/// #
@@ -106,7 +106,7 @@ impl CreateInvite {
106106
/// Create an invite with a max use limit of `5`:
107107
///
108108
/// ```rust,no_run
109-
/// # use serenity::client::CACHE;
109+
/// # use serenity::CACHE;
110110
/// # use serenity::model::ChannelId;
111111
/// # use std::error::Error;
112112
/// #
@@ -138,7 +138,7 @@ impl CreateInvite {
138138
/// Create an invite which is temporary:
139139
///
140140
/// ```rust,no_run
141-
/// # use serenity::client::CACHE;
141+
/// # use serenity::CACHE;
142142
/// # use serenity::model::ChannelId;
143143
/// # use std::error::Error;
144144
/// #
@@ -170,7 +170,7 @@ impl CreateInvite {
170170
/// Create an invite which is unique:
171171
///
172172
/// ```rust,no_run
173-
/// # use serenity::client::CACHE;
173+
/// # use serenity::CACHE;
174174
/// # use serenity::model::ChannelId;
175175
/// # use std::error::Error;
176176
/// #

‎src/cache/mod.rs‎

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,9 @@ impl Cache {
169169
/// # use serenity::prelude::*;
170170
/// # use serenity::model::*;
171171
/// #
172-
/// use serenity::client::CACHE;
172+
/// # #[cfg(feature = "client")]
173+
/// # fn main() {
174+
/// use serenity::CACHE;
173175
/// use std::thread;
174176
/// use std::time::Duration;
175177
///
@@ -193,6 +195,10 @@ impl Cache {
193195
/// }
194196
///
195197
/// let mut client = Client::new("token", Handler); client.start().unwrap();
198+
/// # }
199+
/// #
200+
/// # #[cfg(not(feature = "client"))]
201+
/// # fn main() { }
196202
/// ```
197203
///
198204
/// [`Member`]: ../model/struct.Member.html
@@ -225,7 +231,7 @@ impl Cache {
225231
/// Printing the count of all private channels and groups:
226232
///
227233
/// ```rust,no_run
228-
/// use serenity::client::CACHE;
234+
/// use serenity::CACHE;
229235
///
230236
/// let amount = CACHE.read().unwrap().all_private_channels().len();
231237
///
@@ -252,10 +258,12 @@ impl Cache {
252258
/// Print all of the Ids of guilds in the Cache:
253259
///
254260
/// ```rust,no_run
261+
/// # #[cfg(feature = "client")]
262+
/// # fn main() {
255263
/// # use serenity::prelude::*;
256264
/// # use serenity::model::*;
257265
/// #
258-
/// use serenity::client::CACHE;
266+
/// use serenity::CACHE;
259267
///
260268
/// struct Handler;
261269
/// impl EventHandler for Handler {
@@ -264,6 +272,10 @@ impl Cache {
264272
/// }
265273
/// }
266274
/// let mut client = Client::new("token", Handler);
275+
/// # }
276+
/// #
277+
/// # #[cfg(not(feature = "client"))]
278+
/// # fn main() { }
267279
/// ```
268280
///
269281
/// [`Context`]: ../client/struct.Context.html
@@ -330,7 +342,7 @@ impl Cache {
330342
/// # use std::error::Error;
331343
/// #
332344
/// # fn try_main() -> Result<(), Box<Error>> {
333-
/// use serenity::client::CACHE;
345+
/// use serenity::CACHE;
334346
///
335347
/// let cache = CACHE.read()?;
336348
///
@@ -361,10 +373,12 @@ impl Cache {
361373
/// [`Client::on_message`] event dispatch:
362374
///
363375
/// ```rust,no_run
376+
/// # #[cfg(feature = "client")]
377+
/// # fn main() {
364378
/// # use serenity::prelude::*;
365379
/// # use serenity::model::*;
366380
/// #
367-
/// use serenity::client::CACHE;
381+
/// use serenity::CACHE;
368382
///
369383
/// struct Handler;
370384
///
@@ -387,6 +401,10 @@ impl Cache {
387401
/// }
388402
///
389403
/// let mut client = Client::new("token", Handler); client.start().unwrap();
404+
/// # }
405+
/// #
406+
/// # #[cfg(not(feature = "client"))]
407+
/// # fn main() { }
390408
/// ```
391409
///
392410
/// [`ChannelId`]: ../model/struct.ChannelId.html
@@ -415,7 +433,7 @@ impl Cache {
415433
/// # use std::error::Error;
416434
/// #
417435
/// # fn try_main() -> Result<(), Box<Error>> {
418-
/// use serenity::client::CACHE;
436+
/// use serenity::CACHE;
419437
///
420438
/// let cache = CACHE.read()?;
421439
///
@@ -494,18 +512,22 @@ impl Cache {
494512
///
495513
/// # Examples
496514
///
497-
/// Retrieve a private channel from the cache and send a message:
515+
/// Retrieve a private channel from the cache and print its recipient's
516+
/// name:
498517
///
499518
/// ```rust,no_run
500519
/// # use std::error::Error;
501520
/// #
502521
/// # fn try_main() -> Result<(), Box<Error>> {
503-
/// use serenity::client::CACHE;
522+
/// use serenity::CACHE;
504523
///
505524
/// let cache = CACHE.read()?;
506525
///
507526
/// if let Some(channel) = cache.private_channel(7) {
508-
/// channel.read().unwrap().say("Hello there!");
527+
/// let channel_reader = channel.read().unwrap();
528+
/// let user_reader = channel_reader.recipient.read().unwrap();
529+
///
530+
/// println!("The recipient is {}", user_reader.name);
509531
/// }
510532
/// # Ok(())
511533
/// # }
@@ -537,7 +559,7 @@ impl Cache {
537559
/// # use std::error::Error;
538560
/// #
539561
/// # fn try_main() -> Result<(), Box<Error>> {
540-
/// use serenity::client::CACHE;
562+
/// use serenity::CACHE;
541563
///
542564
/// let cache = CACHE.read()?;
543565
///
@@ -574,7 +596,7 @@ impl Cache {
574596
/// # use std::error::Error;
575597
/// #
576598
/// # fn try_main() -> Result<(), Box<Error>> {
577-
/// use serenity::client::CACHE;
599+
/// use serenity::CACHE;
578600
///
579601
/// let cache = CACHE.read()?;
580602
///

‎src/model/user.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ impl CurrentUser {
4444
/// Print out the current user's avatar url if one is set:
4545
///
4646
/// ```rust,no_run
47-
/// # use serenity::client::CACHE;
47+
/// # use serenity::CACHE;
4848
/// #
4949
/// # let cache = CACHE.read().unwrap();
5050
/// #
@@ -121,7 +121,7 @@ impl CurrentUser {
121121
/// Print out the names of all guilds the current user is in:
122122
///
123123
/// ```rust,no_run
124-
/// # use serenity::client::CACHE;
124+
/// # use serenity::CACHE;
125125
/// #
126126
/// # let cache = CACHE.read().unwrap();
127127
/// #
@@ -149,7 +149,7 @@ impl CurrentUser {
149149
/// Get the invite url with no permissions set:
150150
///
151151
/// ```rust,no_run
152-
/// # use serenity::client::CACHE;
152+
/// # use serenity::CACHE;
153153
/// #
154154
/// # let mut cache = CACHE.write().unwrap();
155155
///
@@ -172,7 +172,7 @@ impl CurrentUser {
172172
/// Get the invite url with some basic permissions set:
173173
///
174174
/// ```rust,no_run
175-
/// # use serenity::client::CACHE;
175+
/// # use serenity::CACHE;
176176
/// #
177177
/// # let mut cache = CACHE.write().unwrap();
178178
///
@@ -228,7 +228,7 @@ impl CurrentUser {
228228
/// Print out the current user's static avatar url if one is set:
229229
///
230230
/// ```rust,no_run
231-
/// # use serenity::client::CACHE;
231+
/// # use serenity::CACHE;
232232
/// #
233233
/// # let cache = CACHE.read().unwrap();
234234
/// #
@@ -252,7 +252,7 @@ impl CurrentUser {
252252
/// Print out the current user's distinct identifier (e.g., Username#1234):
253253
///
254254
/// ```rust,no_run
255-
/// # use serenity::client::CACHE;
255+
/// # use serenity::CACHE;
256256
/// #
257257
/// # let cache = CACHE.read().unwrap();
258258
/// #

0 commit comments

Comments
 (0)