Struct twilight_http::request::guild::ban::GetBans

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

Retrieve the bans for a guild.

Examples

Retrieve the first 25 bans of a guild after a particular user ID:

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

let client = Client::new(env::var("DISCORD_TOKEN")?);

let guild_id = Id::new(1);
let user_id = Id::new(2);

let response = client.bans(guild_id).after(user_id).limit(25)?.await?;
let bans = response.models().await?;

for ban in bans {
    println!("{} was banned for: {:?}", ban.user.name, ban.reason);
}

Implementations

impl<'a> GetBans<'a>

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

Set the user ID after which to retrieve bans.

Mutually exclusive with before. If both are provided then before is respected.

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

Set the user ID before which to retrieve bans.

Mutually exclusive with after. If both are provided then before is respected.

pub const fn limit(self, limit: u16) -> Result<Self, ValidationError>

Set the maximum number of bans to retrieve.

Defaults to Discord’s default.

Refer to [Discord Docs/Get Guild Bans] for more information.

Errors

Returns an error of type GetGuildBans if the limit is invalid.

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

👎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 GetBans<'_>

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

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<ListBody<Ban>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for GetBans<'_>

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

Try to convert a request builder into a raw Request.