aboutsummaryrefslogtreecommitdiff
path: root/src/client/context.rs
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2016-12-02 13:57:49 -0800
committerAustin Hellyer <[email protected]>2016-12-02 13:57:49 -0800
commit57c060fa2fccfbb3b3d4b2d18aad2faa5929deb3 (patch)
tree9bb834ed47a215d4f80f1909b5705a2e69b50950 /src/client/context.rs
parentEncase the event storage in an Arc<RwLock> (diff)
downloadserenity-57c060fa2fccfbb3b3d4b2d18aad2faa5929deb3.tar.xz
serenity-57c060fa2fccfbb3b3d4b2d18aad2faa5929deb3.zip
Paginate rest::get_guilds and add helper methods
Paginate the rest::get_guilds endpoint, which can be used to retrieve the guilds after-or-before a certain guild's Id, with a limit of results to return (100 is the max). Example usage: ```rs use serenity::client::rest::GuildPagination; let target = GuildPagination::After(GuildId(81384788765712384)); let guilds = context.get_guilds(target, 50); ``` Additionally, add a method of `CurrentUser::guilds()`, to retrieve the current user's guilds. A limit of 100 is set, as (most) users can not be in more than 100 guilds.
Diffstat (limited to 'src/client/context.rs')
-rw-r--r--src/client/context.rs28
1 files changed, 24 insertions, 4 deletions
diff --git a/src/client/context.rs b/src/client/context.rs
index a5c9ffa..bc983bf 100644
--- a/src/client/context.rs
+++ b/src/client/context.rs
@@ -4,7 +4,7 @@ use std::fmt::Write as FmtWrite;
use std::io::Read;
use std::sync::{Arc, Mutex};
use super::gateway::Shard;
-use super::rest;
+use super::rest::{self, GuildPagination};
use super::login_type::LoginType;
use ::utils::builder::{
CreateEmbed,
@@ -1050,9 +1050,29 @@ impl Context {
rest::get_guild_prune_count(guild_id.into().0, map)
}
- /// Gets all guilds that the current user is in.
- pub fn get_guilds(&self) -> Result<Vec<GuildInfo>> {
- rest::get_guilds()
+ /// Gets a paginated list of guilds that the current user is in.
+ ///
+ /// The `limit` has a maximum value of 100.
+ ///
+ /// See also: [`CurrentUser::guilds`].
+ ///
+ /// # Examples
+ ///
+ /// Get the first 10 guilds after the current [`Message`]'s guild's Id:
+ ///
+ /// ```rust,ignore
+ /// use serenity::client::rest::GuildPagination;
+ ///
+ /// // assuming you are in a context
+ ///
+ /// let guild_id = message.guild_id.unwrap();
+ /// context.get_guilds(GuildPagination::After(guild_id, 10)).unwrap();
+ /// ```
+ ///
+ /// [`CurrentUser::guilds`]: ../model/struct.CurrentUser.html#method.guilds
+ /// [`Message`]: ../model/struct.Message.html
+ pub fn get_guilds(&self, target: GuildPagination, limit: u8) -> Result<Vec<GuildInfo>> {
+ rest::get_guilds(target, limit as u64)
}
/// Gets all integrations of a guild via the given Id.