Struct ruma_common::events::space::child::SpaceChildEventContent
source · [−]pub struct SpaceChildEventContent {
pub via: Option<Vec<OwnedServerName>>,
pub order: Option<String>,
pub suggested: Option<bool>,
}
events
only.Expand description
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
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
. order
s 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
Trait Implementations
sourceimpl Clone for SpaceChildEventContent
impl Clone for SpaceChildEventContent
sourcefn clone(&self) -> SpaceChildEventContent
fn clone(&self) -> SpaceChildEventContent
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for SpaceChildEventContent
impl Debug for SpaceChildEventContent
sourceimpl Default for SpaceChildEventContent
impl Default for SpaceChildEventContent
sourcefn default() -> SpaceChildEventContent
fn default() -> SpaceChildEventContent
sourceimpl<'de> Deserialize<'de> for SpaceChildEventContent
impl<'de> Deserialize<'de> for SpaceChildEventContent
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl EventContent for SpaceChildEventContent
impl EventContent for SpaceChildEventContent
type EventType = StateEventType
type EventType = StateEventType
sourcefn event_type(&self) -> Self::EventType
fn event_type(&self) -> Self::EventType
m.room.message
.sourceimpl From<SpaceChildEventContent> for AnyStateEventContent
impl From<SpaceChildEventContent> for AnyStateEventContent
sourcefn from(c: SpaceChildEventContent) -> Self
fn from(c: SpaceChildEventContent) -> Self
sourceimpl RedactContent for SpaceChildEventContent
impl RedactContent for SpaceChildEventContent
type Redacted = RedactedSpaceChildEventContent
type Redacted = RedactedSpaceChildEventContent
sourcefn redact(self, version: &RoomVersionId) -> RedactedSpaceChildEventContent
fn redact(self, version: &RoomVersionId) -> RedactedSpaceChildEventContent
self
into a redacted form (removing most or all fields) according to the spec. Read moresourceimpl Serialize for SpaceChildEventContent
impl Serialize for SpaceChildEventContent
sourceimpl StateEventContent for SpaceChildEventContent
impl StateEventContent for SpaceChildEventContent
type StateKey = OwnedRoomId
type StateKey = OwnedRoomId
state_key
field.type Unsigned = StateUnsigned<SpaceChildEventContent>
type Unsigned = StateUnsigned<SpaceChildEventContent>
unsigned
field.