Struct ScheduledEvent

#[non_exhaustive]
pub struct ScheduledEvent {

    pub id: ScheduledEventId,
    pub guild_id: GuildId,
    pub channel_id: Option<ChannelId>,
    pub creator_id: Option<UserId>,
    pub name: String,
    pub description: Option<String>,
    pub start_time: Timestamp,
    pub end_time: Option<Timestamp>,
    pub privacy_level: ScheduledEventPrivacyLevel,
    pub status: ScheduledEventStatus,
    pub creator: Option<User>,
    pub kind: ScheduledEventType,
    pub entity_id: Option<GenericId>,
    pub metadata: Option<ScheduledEventMetadata>,
    pub user_count: Option<u64>,
    pub image: Option<ImageHash>,
}

Information about a guild scheduled event.

Discord docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: ScheduledEventId

The Id of the scheduled event.

guild_id: GuildId

The Id of the guild that the event belongs to.

channel_id: Option<ChannelId>

The Id of the channel that the event belongs to, if any.

creator_id: Option<UserId>

The Id of the User that created the scheduled event.

Only None for events created before October 25th, 2021.

name: String

The name of the scheduled event.

description: Option<String>

The description of the scheduled event, if any.

start_time: Timestamp

The event’s starting time.

end_time: Option<Timestamp>

The event’s ending time; optional.

privacy_level: ScheduledEventPrivacyLevel

The privacy level of the scheduled event.

status: ScheduledEventStatus

The event’s status; either Scheduled, Active, Completed, or Canceled.

creator: Option<User>

The User that created the event.

Only None for events created before October 25th, 2021.

kind: ScheduledEventType

The type of the event, indicating if it will take place in a Stage Instance, a Voice Channel, or at some External location.

entity_id: Option<GenericId>

The id of an entity associated with a guild scheduled event.

metadata: Option<ScheduledEventMetadata>

Optional event location, only required for External events.

user_count: Option<u64>

Number of users interested in the event.

Only populated if with_user_count is set to true provided when calling GuildId::scheduled_event or GuildId::scheduled_events.

image: Option<ImageHash>

The hash of the event’s cover image, if present.

Trait Implementations

impl Clone for ScheduledEvent

fn clone(&self) -> ScheduledEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScheduledEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScheduledEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.