Struct twilight_http::request::guild::create_guild_prune::CreateGuildPrune

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

Begin a guild prune.

Refer to the discord docs for more information.

Implementations

impl<'a> CreateGuildPrune<'a>

pub const fn include_roles(self, roles: &'a [RoleId]) -> 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: u64) -> Result<Self, CreateGuildPruneError>

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 a CreateGuildPruneErrorType::DaysInvalid error type if the number of days is 0.

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

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, AuditLogReasonError>