Struct twilight_http::request::guild::member::search_guild_members::SearchGuildMembers[][src]

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

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::GuildId;

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

let guild_id = GuildId(100);
let members = client.search_guild_members(guild_id, String::from("Wumpus")).limit(10)?.await?;

Errors

Returns SearchGuildMembersError::LimitInvalid if the limit is invalid.

Implementations

impl<'a> SearchGuildMembers<'a>[src]

pub fn limit(self, limit: u64) -> Result<Self, SearchGuildMembersError>[src]

Sets the number of members to retrieve per request.

The limit must be greater than 0 and less than 1000.

Errors

Returns SearchGuildMembersError::LimitInvalid if the limit is 0 or greater than 1000.

Trait Implementations

impl Future for SearchGuildMembers<'_>[src]

type Output = Result<Vec<Member>>

The type of value produced on completion.

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,