Struct twilight_http::request::guild::GetGuildPruneCount
source · pub struct GetGuildPruneCount<'a> { /* private fields */ }
Expand description
Get the counts of guild members to be pruned.
Implementations§
source§impl<'a> GetGuildPruneCount<'a>
impl<'a> GetGuildPruneCount<'a>
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 able to be pruned.
The number of days must be greater than 0, and less than or equal to 30.
Errors
Returns an error of type GuildPruneDays
if the number of days is 0
or more than 30.
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 calculating prune count
sourcepub fn exec(self) -> ResponseFuture<GuildPrune> ⓘ
👎Deprecated since 0.14.0: use .await
or into_future
instead
pub fn exec(self) -> ResponseFuture<GuildPrune> ⓘ
.await
or into_future
insteadExecute the request, returning a future resolving to a Response
.
Trait Implementations§
source§impl IntoFuture for GetGuildPruneCount<'_>
impl IntoFuture for GetGuildPruneCount<'_>
§type Output = Result<Response<GuildPrune>, Error>
type Output = Result<Response<GuildPrune>, Error>
The output that the future will produce on completion.
§type IntoFuture = ResponseFuture<GuildPrune>
type IntoFuture = ResponseFuture<GuildPrune>
Which kind of future are we turning this into?
source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
source§impl TryIntoRequest for GetGuildPruneCount<'_>
impl TryIntoRequest for GetGuildPruneCount<'_>
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for GetGuildPruneCount<'a>
impl<'a> Send for GetGuildPruneCount<'a>
impl<'a> Sync for GetGuildPruneCount<'a>
impl<'a> Unpin for GetGuildPruneCount<'a>
impl<'a> !UnwindSafe for GetGuildPruneCount<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more