Struct twilight_http::request::guild::CreateGuildPrune

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

Begin a guild prune.

See Discord Docs/Begin Guild Prune.

Implementations

impl<'a> CreateGuildPrune<'a>

pub const fn include_roles(self, roles: &'a [Id<RoleMarker>]) -> Self

List of roles to include when pruning.

pub const fn compute_prune_count(self, compute_prune_count: bool) -> Self

Return the amount of pruned members. Discouraged for large guilds.

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

Set the number of days that a user must be inactive before being pruned.

The number of days must be greater than 0.

Errors

Returns an error of type GuildPruneDays if the number of days is 0 or more than 30.

pub fn exec(self) -> ResponseFuture<GuildPrune>

👎Deprecated since 0.14.0: use .await or into_future instead

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

Trait Implementations

impl<'a> AuditLogReason<'a> for CreateGuildPrune<'a>

fn reason(self, reason: &'a str) -> Result<Self, ValidationError>

Attach an audit log reason to the request.

impl IntoFuture for CreateGuildPrune<'_>

type Output = Result<Response<GuildPrune>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<GuildPrune>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for CreateGuildPrune<'_>

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

Try to convert a request builder into a raw Request.