Struct twilight_http::request::guild::member::SearchGuildMembers

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

Search the members of a specific guild by a query.

The upper limit to this request is 1000. Discord defaults the limit to 1.

Examples

Get the first 10 members of guild 100 matching Wumpus:

use twilight_http::Client;
use twilight_model::id::Id;

let client = Client::new("my token".to_owned());

let guild_id = Id::new(100);
let members = client
    .search_guild_members(guild_id, "Wumpus")
    .limit(10)?
    .await?;

Errors

Returns an error of type SearchGuildMembers if the limit is 0 or greater than 1000.

Implementations

impl<'a> SearchGuildMembers<'a>

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 SearchGuildMembers 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 SearchGuildMembers<'_>

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 SearchGuildMembers<'_>

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

Try to convert a request builder into a raw Request.