Struct SpaceParentEventContent

#[non_exhaustive]
pub struct SpaceParentEventContent {
    pub via: Vec<OwnedServerName>,
    pub canonical: bool,
}

The content of an m.space.parent event.

Rooms can claim parents via the m.space.parent state event.

Similar to m.space.child, the state_key is the ID of the parent space, and the content must contain a via key which gives a list of candidate servers that can be used to join the parent.

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.

via: Vec<OwnedServerName>

List of candidate servers that can be used to join the room.

canonical: bool

Determines whether this is the main parent for the space.

When a user joins a room with a canonical parent, clients may switch to view the room in the context of that space, peeking into it in order to find other rooms and group them together. In practice, well behaved rooms should only have one canonical parent, but given this is not enforced: if multiple are present the client should select the one with the lowest room ID, as determined via a lexicographic ordering of the Unicode code-points.

Defaults to false.

Implementations

impl SpaceParentEventContent

pub fn new(via: Vec<OwnedServerName>) -> SpaceParentEventContent

Creates a new SpaceParentEventContent with the given routing servers.

Trait Implementations

impl Clone for SpaceParentEventContent

fn clone(&self) -> SpaceParentEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpaceParentEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpaceParentEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for SpaceParentEventContent

type EventType = StateEventType

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

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

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

impl From<SpaceParentEventContent> for AnyStateEventContent

fn from(c: SpaceParentEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl RedactContent for SpaceParentEventContent

type Redacted = RedactedSpaceParentEventContent

The redacted form of the event’s content.

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

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

impl Serialize for SpaceParentEventContent

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 SpaceParentEventContent

type StateKey = OwnedRoomId

The type of the event’s state_key field.

impl StaticEventContent for SpaceParentEventContent

const TYPE: &'static str = "m.space.parent"

The event type.

impl StaticStateEventContent for SpaceParentEventContent

type PossiblyRedacted = PossiblyRedactedSpaceParentEventContent

The possibly redacted form of the event’s content.

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

The type of the event’s unsigned field.