Struct twilight_model::scheduled_event::GuildScheduledEvent

pub struct GuildScheduledEvent {

    pub channel_id: Option<Id<ChannelMarker>>,
    pub creator: Option<User>,
    pub creator_id: Option<Id<UserMarker>>,
    pub description: Option<String>,
    pub entity_id: Option<Id<ScheduledEventEntityMarker>>,
    pub entity_metadata: Option<EntityMetadata>,
    pub entity_type: EntityType,
    pub guild_id: Id<GuildMarker>,
    pub id: Id<ScheduledEventMarker>,
    pub image: Option<ImageHash>,
    pub name: String,
    pub privacy_level: PrivacyLevel,
    pub scheduled_end_time: Option<Timestamp>,
    pub scheduled_start_time: Timestamp,
    pub status: Status,
    pub user_count: Option<u64>,
}

Representation of a scheduled event.

For events created before October 25th, 2021, creator and creator_id will be None.

Fields

channel_id: Option<Id<ChannelMarker>>

ID of the stage or voice channel if there is one.

Present on events of EntityType::StageInstance and EntityType::Voice.

creator: Option<User>

User object of the event’s creator.

Only present on events created after October 25th, 2021.

creator_id: Option<Id<UserMarker>>

ID of the event’s creator.

Only present on events created after October 25th, 2021.

description: Option<String>

Description of the event.

entity_id: Option<Id<ScheduledEventEntityMarker>>

ID of the event’s entity.

entity_metadata: Option<EntityMetadata>

Metadata of an entity, if it exists.

Currently, only present on events of EntityType::External.

entity_type: EntityType

Type of entity associated with the event.

guild_id: Id<GuildMarker>

ID of the guild the event takes place in.

id: Id<ScheduledEventMarker>

ID of the event.

image: Option<ImageHash>

Hash of the event’s cover image, if it has one.

name: String

Name of the event.

privacy_level: PrivacyLevel

Privacy level of the event.

scheduled_end_time: Option<Timestamp>

Scheduled end time of the event.

Required on events of type EntityType::External. It also may be present in other event types.

scheduled_start_time: Timestamp

Scheduled start time of the event.

status: Status

Status of the event.

user_count: Option<u64>

Number of users subscribed to the event.

Trait Implementations

impl Clone for GuildScheduledEvent

fn clone(&self) -> GuildScheduledEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GuildScheduledEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GuildScheduledEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for GuildScheduledEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<GuildScheduledEvent> for GuildScheduledEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for GuildScheduledEvent

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 GuildScheduledEvent

impl StructuralEq for GuildScheduledEvent

impl StructuralPartialEq for GuildScheduledEvent