Struct CachedGuild 

pub struct CachedGuild { /* private fields */ }

Represents a cached Guild.

Implementations

impl CachedGuild

pub const fn afk_channel_id(&self) -> Option<Id<ChannelMarker>>

ID of the AFK channel.

pub const fn afk_timeout(&self) -> AfkTimeout

AFK timeout in seconds.

pub const fn application_id(&self) -> Option<Id<ApplicationMarker>>

For bot created guilds, the ID of the creating application.

pub const fn banner(&self) -> Option<&ImageHash>

Banner hash.

See Discord Docs/Image Formatting.

pub const fn default_message_notifications( &self, ) -> DefaultMessageNotificationLevel

Default message notification level.

pub fn description(&self) -> Option<&str>

For Community guilds, the description.

pub const fn discovery_splash(&self) -> Option<&ImageHash>

For discoverable guilds, the discovery splash hash.

See Discord Docs/Image Formatting.

pub const fn explicit_content_filter(&self) -> ExplicitContentFilter

Explicit content filter level.

pub fn features(&self) -> Features<'_>

Enabled guild features.

pub fn guild_scheduled_events(&self) -> &[GuildScheduledEvent]

Scheduled guild events.

pub const fn icon(&self) -> Option<&ImageHash>

Icon hash.

See Discord Docs/Image Formatting.

pub const fn id(&self) -> Id<GuildMarker>

ID of the guild.

pub const fn joined_at(&self) -> Option<Timestamp>

[Timestamp] of the user’s join date.

pub const fn large(&self) -> bool

Whether this guild is “large”.

pub const fn max_members(&self) -> Option<u64>

Maximum members.

pub const fn max_presences(&self) -> Option<u64>

Maximum presences.

pub const fn max_stage_video_channel_users(&self) -> Option<u64>

Maximum number of users in a stage video channel.

pub const fn max_video_channel_users(&self) -> Option<u64>

Maximum number of users in a video channel.

pub const fn member_count(&self) -> Option<u64>

Total number of members in the guild.

pub const fn mfa_level(&self) -> MfaLevel

Required MFA level.

pub fn name(&self) -> &str

Name of the guild.

pub const fn nsfw_level(&self) -> NSFWLevel

NSFW level.

pub const fn owner(&self) -> Option<bool>

Whether the current user is the owner of the guild.

pub const fn owner_id(&self) -> Id<UserMarker>

ID of the guild’s owner.

pub const fn permissions(&self) -> Option<Permissions>

Total permissions for the current user in the guild, excluding overwrites.

pub fn preferred_locale(&self) -> &str

Preferred locale for Community guilds.

Used in server discovery and notices from Discord. Defaults to “en-US”.

pub const fn premium_progress_bar_enabled(&self) -> bool

Whether the premium progress bar is enabled.

pub const fn premium_subscription_count(&self) -> Option<u64>

Number of boosts this guild currently has.

pub const fn premium_tier(&self) -> PremiumTier

Server boost level.

pub const fn public_updates_channel_id(&self) -> Option<Id<ChannelMarker>>

ID of the where moderators of Community guilds receive notices from Discord.

pub const fn rules_channel_id(&self) -> Option<Id<ChannelMarker>>

For Community guilds, the ID of the rules channel.

pub const fn safety_alerts_channel_id(&self) -> Option<Id<ChannelMarker>>

The ID of the channel where admins and moderators of Community guilds receive safety alerts from Discord.

pub const fn splash(&self) -> Option<&ImageHash>

Splash hash.

See Discord Docs/Image Formatting.

pub const fn system_channel_id(&self) -> Option<Id<ChannelMarker>>

ID of the channel where notices are posted.

Example notices include welcome messages and boost events.

pub const fn system_channel_flags(&self) -> SystemChannelFlags

System channel flags.

pub const fn unavailable(&self) -> Option<bool>

Whether the guild is unavailable due to an outage.

pub fn vanity_url_code(&self) -> Option<&str>

Vanity URL code.

pub const fn verification_level(&self) -> VerificationLevel

Required verification level.

pub const fn widget_channel_id(&self) -> Option<Id<ChannelMarker>>

ID of the channel that a widget generates an invite to.

pub const fn widget_enabled(&self) -> Option<bool>

Whether the widget is enabled.

Trait Implementations

impl CacheableGuild for CachedGuild

fn id(&self) -> Id<GuildMarker>

ID of the guild.

fn owner_id(&self) -> Id<UserMarker>

Available on crate feature permission-calculator only.

ID of the guild’s owner.

fn set_unavailable(&mut self, unavailable: Option<bool>)

Set the guild’s unavailable flag.

fn update_with_guild_update(&mut self, guild_update: &GuildUpdate)

Update the cached data with a [GuildUpdate] event. Fields containing other cached structures such as channels are cleared prior.

fn increase_member_count(&mut self, amount: u64)

Increase the guild member count.

fn decrease_member_count(&mut self, amount: u64)

Decrease the guild member count.

impl Clone for CachedGuild

fn clone(&self) -> CachedGuild

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CachedGuild

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Guild> for CachedGuild

fn from(guild: Guild) -> Self

Converts to this type from the input type.

impl PartialEq<Guild> for CachedGuild

fn eq(&self, other: &Guild) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for CachedGuild

fn eq(&self, other: &CachedGuild) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CachedGuild

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CachedGuild

impl StructuralPartialEq for CachedGuild