Struct ruma_events::InitialStateEvent

source ·
pub struct InitialStateEvent<C: StaticStateEventContent> {
    pub content: C,
    pub state_key: C::StateKey,
}
Expand description

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

Fields§

§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 is often an empty string, but some events send a UserId to show which user the event affects.

Defaults to the empty string.

Implementations§

source§

impl<C: StaticStateEventContent> InitialStateEvent<C>

source

pub fn new(content: C) -> Self

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.

source

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.

source

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§

source§

impl<C: Clone + StaticStateEventContent> Clone for InitialStateEvent<C>
where C::StateKey: Clone,

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<C: Debug + StaticStateEventContent> Debug for InitialStateEvent<C>
where C::StateKey: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<C> Default for InitialStateEvent<C>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<InitialStateEvent<CallMemberEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialCallMemberEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<PolicyRuleRoomEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialPolicyRuleRoomEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<PolicyRuleServerEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialPolicyRuleServerEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<PolicyRuleUserEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialPolicyRuleUserEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomAliasesEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomAliasesEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomAvatarEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomAvatarEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomCanonicalAliasEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomCanonicalAliasEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomCreateEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomCreateEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomEncryptionEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomEncryptionEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomGuestAccessEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomGuestAccessEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomHistoryVisibilityEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomHistoryVisibilityEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomJoinRulesEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomJoinRulesEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomMemberEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomMemberEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomNameEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomNameEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomPinnedEventsEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomPinnedEventsEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomPowerLevelsEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomPowerLevelsEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomServerAclEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomServerAclEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomThirdPartyInviteEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomThirdPartyInviteEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomTombstoneEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomTombstoneEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<RoomTopicEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialRoomTopicEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<SpaceChildEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialSpaceChildEvent) -> Self

Converts to this type from the input type.
source§

impl From<InitialStateEvent<SpaceParentEventContent>> for AnyInitialStateEvent

source§

fn from(c: InitialSpaceParentEvent) -> Self

Converts to this type from the input type.
source§

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

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,