Struct ruma_common::events::space::child::SpaceChildEventContent

#[non_exhaustive]
pub struct SpaceChildEventContent {
    pub via: Option<Vec<OwnedServerName>>,
    pub order: Option<String>,
    pub suggested: Option<bool>,
}

The content of an m.space.child event.

The admins of a space can advertise rooms and subspaces for their space by setting m.space.child state events.

The state_key is the ID of a child room or space, and the content must contain a via key which gives a list of candidate servers that can be used to join the 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.

via: Option<Vec<OwnedServerName>>

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

order: Option<String>

Provide a default ordering of siblings in the room list.

Rooms are sorted based on a lexicographic ordering of the Unicode codepoints of the characters in order values. Rooms with no order come last, in ascending numeric order of the origin_server_ts of their m.room.create events, or ascending lexicographic order of their room_ids in case of equal origin_server_ts. orders which are not strings, or do not consist solely of ascii characters in the range \x20 (space) to \x7E (~), or consist of more than 50 characters, are forbidden and the field should be ignored if received.

suggested: Option<bool>

Space admins can mark particular children of a space as “suggested”.

This mainly serves as a hint to clients that that they can be displayed differently, for example by showing them eagerly in the room list. A child which is missing the suggested property is treated identically to a child with "suggested": false. A suggested child may be a room or a subspace.

Implementations

impl SpaceChildEventContent

pub fn new() -> Self

Creates a new ChildEventContent.

Trait Implementations

impl Clone for SpaceChildEventContent

fn clone(&self) -> SpaceChildEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpaceChildEventContent

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

Formats the value using the given formatter.

impl Default for SpaceChildEventContent

fn default() -> SpaceChildEventContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpaceChildEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for SpaceChildEventContent

type EventType = StateEventType

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

fn event_type(&self) -> Self::EventType

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

impl From<SpaceChildEventContent> for AnyStateEventContent

fn from(c: SpaceChildEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for SpaceChildEventContent

type Redacted = RedactedSpaceChildEventContent

The redacted form of the event’s content.

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

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

impl Serialize for SpaceChildEventContent

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

Serialize this value into the given Serde serializer.

impl StateEventContent for SpaceChildEventContent

type StateKey = OwnedRoomId

The type of the event’s state_key field.

impl StaticEventContent for SpaceChildEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::State{redacted: false,}

The event’s “kind”.

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

The event type.