Struct serenity::model::invite::RichInvite [−][src]
#[non_exhaustive]pub struct RichInvite { pub channel: InviteChannel, pub code: String, pub created_at: DateTime<Utc>, pub guild: Option<InviteGuild>, pub inviter: 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
Expand description
A representation of the minimal amount of information needed about the channel being invited to.
code: String
Expand description
The unique code for the invite.
created_at: DateTime<Utc>
Expand description
When the invite was created.
guild: Option<InviteGuild>
Expand description
A representation of the minimal amount of information needed about the
Guild
being invited to.
inviter: User
Expand description
The user that created the invite.
max_age: u64
Expand description
The maximum age of the invite in seconds, from when it was created.
max_uses: u64
Expand description
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
Expand description
Indicator of whether the invite self-expires after a certain amount of time or uses.
uses: u64
Expand description
The amount of times that an invite has been used.
Implementations
impl RichInvite
[src]
impl RichInvite
[src]pub async fn delete(&self, cache_http: impl CacheHttp) -> Result<Invite>
[src]
pub async fn delete(&self, cache_http: impl CacheHttp) -> Result<Invite>
[src]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
impl Clone for RichInvite
[src]
impl Clone for RichInvite
[src]fn clone(&self) -> RichInvite
[src]
fn clone(&self) -> RichInvite
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for RichInvite
[src]
impl Debug for RichInvite
[src]impl<'de> Deserialize<'de> for RichInvite
[src]
impl<'de> Deserialize<'de> for RichInvite
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl Serialize for RichInvite
[src]
impl Serialize for RichInvite
[src]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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
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>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,