1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
use crate::{
client::Client,
error::Error,
request::{Request, TryIntoRequest},
response::{marker::ListBody, Response, ResponseFuture},
routing::Route,
};
use std::future::IntoFuture;
use twilight_model::{
guild::Member,
id::{
marker::{GuildMarker, UserMarker},
Id,
},
};
use twilight_validate::request::{
get_guild_members_limit as validate_get_guild_members_limit, ValidationError,
};
struct GetGuildMembersFields {
after: Option<Id<UserMarker>>,
limit: Option<u16>,
}
/// Get the members of a guild, by id.
///
/// The upper limit to this request is 1000. If more than 1000 members are needed, the requests
/// must be chained. Discord defaults the limit to 1.
///
/// # Examples
///
/// Get the first 500 members of guild `100` after user ID `3000`:
///
/// ```no_run
/// use twilight_http::Client;
/// use twilight_model::id::Id;
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = Client::new("my token".to_owned());
///
/// let guild_id = Id::new(100);
/// let user_id = Id::new(3000);
/// let members = client
/// .guild_members(guild_id)
/// .after(user_id)
/// .limit(500)?
/// .await?;
/// # Ok(()) }
/// ```
#[must_use = "requests must be configured and executed"]
pub struct GetGuildMembers<'a> {
fields: GetGuildMembersFields,
guild_id: Id<GuildMarker>,
http: &'a Client,
}
impl<'a> GetGuildMembers<'a> {
pub(crate) const fn new(http: &'a Client, guild_id: Id<GuildMarker>) -> Self {
Self {
fields: GetGuildMembersFields {
after: None,
limit: None,
},
guild_id,
http,
}
}
/// Sets the user ID to get members after.
pub const fn after(mut self, after: Id<UserMarker>) -> Self {
self.fields.after = Some(after);
self
}
/// Sets the number of members to retrieve per request.
///
/// The limit must be greater than 0 and less than 1000.
///
/// # Errors
///
/// Returns an error of type [`GetGuildMembers`] if the limit is 0 or
/// greater than 1000.
///
/// [`GetGuildMembers`]: twilight_validate::request::ValidationErrorType::GetGuildMembers
pub const fn limit(mut self, limit: u16) -> Result<Self, ValidationError> {
#[allow(clippy::question_mark)]
if let Err(source) = validate_get_guild_members_limit(limit) {
return Err(source);
}
self.fields.limit = Some(limit);
Ok(self)
}
/// Execute the request, returning a future resolving to a [`Response`].
#[deprecated(since = "0.14.0", note = "use `.await` or `into_future` instead")]
pub fn exec(self) -> ResponseFuture<ListBody<Member>> {
self.into_future()
}
}
impl IntoFuture for GetGuildMembers<'_> {
type Output = Result<Response<ListBody<Member>>, Error>;
type IntoFuture = ResponseFuture<ListBody<Member>>;
fn into_future(self) -> Self::IntoFuture {
let http = self.http;
match self.try_into_request() {
Ok(request) => http.request(request),
Err(source) => ResponseFuture::error(source),
}
}
}
impl TryIntoRequest for GetGuildMembers<'_> {
fn try_into_request(self) -> Result<Request, Error> {
Ok(Request::from_route(&Route::GetGuildMembers {
after: self.fields.after.map(Id::get),
guild_id: self.guild_id.get(),
limit: self.fields.limit,
}))
}
}