[][src]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>[src]

pub fn include_roles(self, roles: impl Iterator<Item = RoleId>) -> Self[src]

List of roles to include when pruning.

pub fn compute_prune_count(self, compute_prune_count: bool) -> Self[src]

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

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

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 CreateGuildPruneError::DaysInvalid if the number of days is 0.

pub fn reason(self, reason: impl Into<String>) -> Self[src]

👎 Deprecated since 0.1.5:

please prefer the request::AuditLogReason trait

Attach an audit log reason to this request.

Trait Implementations

impl<'a> AuditLogReason for CreateGuildPrune<'a>[src]

impl<'_> Future for CreateGuildPrune<'_>[src]

type Output = Result<Option<GuildPrune>>

The type of value produced on completion.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for CreateGuildPrune<'a>

impl<'a> Send for CreateGuildPrune<'a>

impl<'a> !Sync for CreateGuildPrune<'a>

impl<'a> Unpin for CreateGuildPrune<'a>

impl<'a> !UnwindSafe for CreateGuildPrune<'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
[src]

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.