Struct InitialStateEvent

pub struct InitialStateEvent<C>
where
    C: StaticStateEventContent,
{
    pub content: C,
    pub state_key: <C as StateEventContent>::StateKey,
}

A minimal state event, used for creating a new room.

Fields

content: C

Data specific to the event type.

state_key: <C as StateEventContent>::StateKey

A unique key which defines the overwriting semantics for this piece of room state.

This is often an empty string, but some events send a UserId to show which user the event affects.

Defaults to the empty string.

Implementations

impl<C> InitialStateEvent<C>

where C: StaticStateEventContent,

pub fn new(content: C) -> InitialStateEvent<C>

where C: StaticStateEventContent<StateKey = EmptyStateKey>,

Available on crate feature unstable-msc3489 only.

Create a new InitialStateEvent for an event type with an empty state key.

For cases where the state key is not empty, use a struct literal to create the event.

pub fn to_raw(&self) -> Raw<InitialStateEvent<C>>

Available on crate feature unstable-msc3489 only.

Shorthand for Raw::new(self).unwrap().

Since none of the content types in Ruma ever return an error in serialization, this will never panic with C being a type from Ruma. However, if you use a custom content type with a Serialize implementation that can error (for example because it contains an enum with one or more variants that use the #[serde(skip)] attribute), this method can panic.

pub fn to_raw_any(&self) -> Raw<AnyInitialStateEvent>

Available on crate feature unstable-msc3489 only.

Shorthand for self.to_raw().cast::<AnyInitialStateEvent>().

Since none of the content types in Ruma ever return an error in serialization, this will never panic with C being a type from Ruma. However, if you use a custom content type with a Serialize implementation that can error (for example because it contains an enum with one or more variants that use the #[serde(skip)] attribute), this method can panic.

Trait Implementations

impl<C> Clone for InitialStateEvent<C>

where C: Clone + StaticStateEventContent, <C as StateEventContent>::StateKey: Clone,

fn clone(&self) -> InitialStateEvent<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for InitialStateEvent<C>

where C: Debug + StaticStateEventContent, <C as StateEventContent>::StateKey: Debug,

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

Formats the value using the given formatter.

impl<C> Default for InitialStateEvent<C>

where C: StaticStateEventContent<StateKey = EmptyStateKey> + Default,

fn default() -> InitialStateEvent<C>

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for InitialStateEvent<C>

where C: StaticStateEventContent + EventContentFromType,

fn deserialize<D>( deserializer: D, ) -> Result<InitialStateEvent<C>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InitialStateEvent<BeaconInfoEventContent>> for AnyInitialStateEvent

Available on crate feature unstable-msc3489 only.

fn from(c: InitialStateEvent<BeaconInfoEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<CallMemberEventContent>> for AnyInitialStateEvent

Available on crate feature unstable-msc3401 only.

fn from(c: InitialStateEvent<CallMemberEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<MemberHintsEventContent>> for AnyInitialStateEvent

Available on crate feature unstable-msc4171 only.

fn from(c: InitialStateEvent<MemberHintsEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleRoomEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<PolicyRuleRoomEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleServerEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<PolicyRuleServerEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleUserEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<PolicyRuleUserEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomAliasesEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomAliasesEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomAvatarEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomAvatarEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomCanonicalAliasEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomCanonicalAliasEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomCreateEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomCreateEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomEncryptionEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomEncryptionEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomGuestAccessEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomGuestAccessEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomHistoryVisibilityEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomHistoryVisibilityEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomJoinRulesEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomJoinRulesEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomMemberEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomMemberEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomNameEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomNameEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomPinnedEventsEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomPinnedEventsEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomPowerLevelsEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomPowerLevelsEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomServerAclEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomServerAclEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomThirdPartyInviteEventContent>> for AnyInitialStateEvent

fn from( c: InitialStateEvent<RoomThirdPartyInviteEventContent>, ) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomTombstoneEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomTombstoneEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<RoomTopicEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<RoomTopicEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<SpaceChildEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<SpaceChildEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl From<InitialStateEvent<SpaceParentEventContent>> for AnyInitialStateEvent

fn from(c: InitialStateEvent<SpaceParentEventContent>) -> AnyInitialStateEvent

Converts to this type from the input type.

impl<C> Serialize for InitialStateEvent<C>

where C: StaticStateEventContent,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.