#[non_exhaustive]pub struct RichInvite {
pub channel: InviteChannel,
pub code: String,
pub created_at: Timestamp,
pub guild: Option<InviteGuild>,
pub inviter: Option<User>,
pub max_age: u64,
pub max_uses: u64,
pub temporary: bool,
pub uses: u64,
}
Expand description
Detailed information about an invite.
This information can only be retrieved by anyone with the Manage Guild
permission. Otherwise, a minimal amount of information can be retrieved via
the Invite
struct.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.channel: InviteChannel
A representation of the minimal amount of information needed about the channel being invited to.
code: String
The unique code for the invite.
created_at: Timestamp
When the invite was created.
guild: Option<InviteGuild>
A representation of the minimal amount of information needed about the
Guild
being invited to.
inviter: Option<User>
The user that created the invite.
max_age: u64
The maximum age of the invite in seconds, from when it was created.
max_uses: u64
The maximum number of times that an invite may be used before it expires.
Note that this does not supersede the Self::max_age
value, if the value of
Self::temporary
is true
. If the value of temporary
is false
, then the
invite will self-expire after the given number of max uses.
If the value is 0
, then the invite is permanent.
temporary: bool
Indicator of whether the invite self-expires after a certain amount of time or uses.
uses: u64
The amount of times that an invite has been used.
Implementations
sourceimpl RichInvite
impl RichInvite
sourcepub async fn delete(&self, cache_http: impl CacheHttp) -> Result<Invite>
Available on crate feature model
only.
pub async fn delete(&self, cache_http: impl CacheHttp) -> Result<Invite>
model
only.Deletes the invite.
Refer to Http::delete_invite
for more information.
Note: Requires the Manage Guild permission.
Errors
If the cache
feature is enabled, then this returns a
ModelError::InvalidPermissions
if the current user does not have
the required permission.
Trait Implementations
sourceimpl Clone for RichInvite
impl Clone for RichInvite
sourcefn clone(&self) -> RichInvite
fn clone(&self) -> RichInvite
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for RichInvite
impl Debug for RichInvite
sourceimpl<'de> Deserialize<'de> for RichInvite
impl<'de> Deserialize<'de> for RichInvite
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for RichInvite
impl Serialize for RichInvite
Auto Trait Implementations
impl RefUnwindSafe for RichInvite
impl Send for RichInvite
impl Sync for RichInvite
impl Unpin for RichInvite
impl UnwindSafe for RichInvite
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>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
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