Struct twilight_http::request::guild::member::GetGuildMembers

pub struct GetGuildMembers<'a> { /* private fields */ }

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)
    .limit(500)?
    .await?;

Implementations

impl<'a> GetGuildMembers<'a>

pub const fn after(self, after: Id<UserMarker>) -> Self

Sets the user ID to get members after.

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.

pub fn exec(self) -> ResponseFuture<ListBody<Member>>

👎Deprecated since 0.14.0: use .await or into_future instead

Execute the request, returning a future resolving to a Response.

Trait Implementations

impl IntoFuture for GetGuildMembers<'_>

type Output = Result<Response<ListBody<Member>>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<ListBody<Member>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for GetGuildMembers<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.