ruma::events::room::avatar

Type Alias InitialRoomAvatarEvent

Source
pub type InitialRoomAvatarEvent = InitialStateEvent<RoomAvatarEventContent>;
Available on crate feature events only.
Expand description

An m.room.avatar event for creating a room.

Aliased Type§

struct InitialRoomAvatarEvent {
    pub content: RoomAvatarEventContent,
    pub state_key: EmptyStateKey,
}

Fields§

§content: RoomAvatarEventContent

Data specific to the event type.

§state_key: EmptyStateKey

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> InitialStateEvent<C>

Source

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

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.

Source

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.

Source

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

Source§

impl<C> Clone for InitialStateEvent<C>

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 for InitialStateEvent<C>

Source§

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

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

impl<C> Default for InitialStateEvent<C>

Source§

fn default() -> InitialStateEvent<C>

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<InitialStateEvent<C>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

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

impl<C> Serialize for InitialStateEvent<C>

Source§

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. Read more