Struct twilight_http::request::guild::CreateGuildPrune
source · [−]pub struct CreateGuildPrune<'a> { /* private fields */ }Expand description
Begin a guild prune.
Implementations
sourceimpl<'a> CreateGuildPrune<'a>
impl<'a> CreateGuildPrune<'a>
sourcepub const fn include_roles(self, roles: &'a [Id<RoleMarker>]) -> Self
pub const fn include_roles(self, roles: &'a [Id<RoleMarker>]) -> Self
List of roles to include when pruning.
sourcepub const fn compute_prune_count(self, compute_prune_count: bool) -> Self
pub const fn compute_prune_count(self, compute_prune_count: bool) -> Self
Return the amount of pruned members. Discouraged for large guilds.
sourcepub const fn days(self, days: u16) -> Result<Self, ValidationError>
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.
sourcepub fn exec(self) -> ResponseFuture<GuildPrune>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
pub fn exec(self) -> ResponseFuture<GuildPrune>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
Execute the request, returning a future resolving to a Response.
Trait Implementations
sourceimpl<'a> AuditLogReason<'a> for CreateGuildPrune<'a>
impl<'a> AuditLogReason<'a> for CreateGuildPrune<'a>
sourceimpl TryIntoRequest for CreateGuildPrune<'_>
impl TryIntoRequest for CreateGuildPrune<'_>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more