Struct twilight_http::request::guild::member::SearchGuildMembers
source · pub struct SearchGuildMembers<'a> { /* private fields */ }
Expand description
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
sourceimpl<'a> SearchGuildMembers<'a>
impl<'a> SearchGuildMembers<'a>
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 SearchGuildMembers
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 SearchGuildMembers<'_>
impl IntoFuture for SearchGuildMembers<'_>
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 SearchGuildMembers<'_>
impl TryIntoRequest for SearchGuildMembers<'_>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for SearchGuildMembers<'a>
impl<'a> Send for SearchGuildMembers<'a>
impl<'a> Sync for SearchGuildMembers<'a>
impl<'a> Unpin for SearchGuildMembers<'a>
impl<'a> !UnwindSafe for SearchGuildMembers<'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