Struct twilight_http::request::guild::member::GetGuildMembers
source · pub struct GetGuildMembers<'a> { /* private fields */ }
Expand description
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
:
use twilight_http::Client;
use twilight_model::id::Id;
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).await?;
Implementations
sourceimpl<'a> GetGuildMembers<'a>
impl<'a> GetGuildMembers<'a>
sourcepub const fn after(self, after: Id<UserMarker>) -> Self
pub const fn after(self, after: Id<UserMarker>) -> Self
Sets the user ID to get members after.
sourcepub const fn limit(self, limit: u16) -> Result<Self, ValidationError>
pub const fn limit(self, limit: u16) -> Result<Self, ValidationError>
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.
sourcepub fn exec(self) -> ResponseFuture<MemberListBody> ⓘ
👎Deprecated since 0.14.0: use .await
or into_future
instead
pub fn exec(self) -> ResponseFuture<MemberListBody> ⓘ
.await
or into_future
insteadExecute the request, returning a future resolving to a Response
.
Trait Implementations
sourceimpl IntoFuture for GetGuildMembers<'_>
impl IntoFuture for GetGuildMembers<'_>
type Output = Result<Response<MemberListBody>, Error>
type Output = Result<Response<MemberListBody>, Error>
The output that the future will produce on completion.
type IntoFuture = ResponseFuture<MemberListBody>
type IntoFuture = ResponseFuture<MemberListBody>
Which kind of future are we turning this into?
sourcefn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
sourceimpl TryIntoRequest for GetGuildMembers<'_>
impl TryIntoRequest for GetGuildMembers<'_>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for GetGuildMembers<'a>
impl<'a> Send for GetGuildMembers<'a>
impl<'a> Sync for GetGuildMembers<'a>
impl<'a> Unpin for GetGuildMembers<'a>
impl<'a> !UnwindSafe for GetGuildMembers<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more