Struct ruma::events::room::pinned_events::RoomPinnedEventsEventContent

#[non_exhaustive]
pub struct RoomPinnedEventsEventContent {
    pub pinned: Vec<OwnedEventId>,
}

The content of an m.room.pinned_events event.

Used to “pin” particular events in a room for other participants to review later.

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.

pinned: Vec<OwnedEventId>

An ordered list of event IDs to pin.

Implementations

impl RoomPinnedEventsEventContent

pub fn new(pinned: Vec<OwnedEventId>) -> RoomPinnedEventsEventContent

Creates a new RoomPinnedEventsEventContent with the given events.

Trait Implementations

impl Clone for RoomPinnedEventsEventContent

fn clone(&self) -> RoomPinnedEventsEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomPinnedEventsEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomPinnedEventsEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomPinnedEventsEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type( &self, ) -> <RoomPinnedEventsEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

impl From<RoomPinnedEventsEventContent> for AnyStateEventContent

fn from(c: RoomPinnedEventsEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl RedactContent for RoomPinnedEventsEventContent

type Redacted = RedactedRoomPinnedEventsEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedRoomPinnedEventsEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomPinnedEventsEventContent

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.

impl StateEventContent for RoomPinnedEventsEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomPinnedEventsEventContent

const TYPE: &'static str = "m.room.pinned_events"

The event type.

impl StaticStateEventContent for RoomPinnedEventsEventContent

type PossiblyRedacted = PossiblyRedactedRoomPinnedEventsEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomPinnedEventsEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.