Struct InitialStateEvent 

#[non_exhaustive]
pub struct InitialStateEvent<C: StaticStateEventContent> {
    pub content: C,
    pub state_key: C::StateKey,
}

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

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.

content: C

Data specific to the event type.

state_key: C::StateKey

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

This must be a string type, and is often an empty string.

A state event is keyed by its (type, state_key) tuple. Sending another state event with the same tuple replaces the previous one.

Defaults to the empty string.

Implementations

impl<C: StaticStateEventContent> InitialStateEvent<C>

pub fn new(state_key: C::StateKey, content: C) -> Self

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

For cases where the state key is empty, with_empty_state_key() can be used instead.

pub fn with_empty_state_key(content: C) -> Self

where C: StaticStateEventContent<StateKey = EmptyStateKey>,

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

For cases where the state key is not empty, use new().

pub fn to_raw(&self) -> Raw<Self>

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>

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 + StaticStateEventContent> Clone for InitialStateEvent<C>

where C::StateKey: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + StaticStateEventContent> Debug for InitialStateEvent<C>

where C::StateKey: Debug,

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

Formats the value using the given formatter.

impl<C> Default for InitialStateEvent<C>

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

fn default() -> Self

Returns the “default value” for a type.

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

where C: EventContentFromType + StaticStateEventContent,

fn deserialize<D>(deserializer: D) -> Result<Self, D::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: InitialBeaconInfoEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<CallMemberEventContent>> for AnyInitialStateEvent

Available on crate feature unstable-msc3401 only.

fn from(c: InitialCallMemberEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<MemberHintsEventContent>> for AnyInitialStateEvent

Available on crate feature unstable-msc4171 only.

fn from(c: InitialMemberHintsEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleRoomEventContent>> for AnyInitialStateEvent

fn from(c: InitialPolicyRuleRoomEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleServerEventContent>> for AnyInitialStateEvent

fn from(c: InitialPolicyRuleServerEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<PolicyRuleUserEventContent>> for AnyInitialStateEvent

fn from(c: InitialPolicyRuleUserEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomAliasesEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomAliasesEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomAvatarEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomAvatarEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomCanonicalAliasEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomCanonicalAliasEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomCreateEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomCreateEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomEncryptionEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomEncryptionEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomGuestAccessEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomGuestAccessEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomHistoryVisibilityEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomHistoryVisibilityEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomJoinRulesEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomJoinRulesEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomMemberEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomMemberEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomNameEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomNameEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomPinnedEventsEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomPinnedEventsEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomPowerLevelsEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomPowerLevelsEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomServerAclEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomServerAclEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomThirdPartyInviteEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomThirdPartyInviteEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomTombstoneEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomTombstoneEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<RoomTopicEventContent>> for AnyInitialStateEvent

fn from(c: InitialRoomTopicEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<SpaceChildEventContent>> for AnyInitialStateEvent

fn from(c: InitialSpaceChildEvent) -> Self

Converts to this type from the input type.

impl From<InitialStateEvent<SpaceParentEventContent>> for AnyInitialStateEvent

fn from(c: InitialSpaceParentEvent) -> Self

Converts to this type from the input type.

impl<C: StaticStateEventContent> Serialize for InitialStateEvent<C>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: StaticStateEventContent> JsonCastable<AnyInitialStateEvent> for InitialStateEvent<C>

impl<C: StaticStateEventContent> JsonCastable<Map<String, Value>> for InitialStateEvent<C>