Struct ruma_events::space::child::ChildEventContent

pub struct ChildEventContent {
    pub via: Option<Vec<ServerNameBox>>,
    pub order: Option<String>,
    pub suggested: Option<bool>,
}

This is supported on crate feature unstable-pre-spec only.

The payload for ChildEvent.

Fields

via: Option<Vec<ServerNameBox>>

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 ChildEventContent

pub fn new() -> Self

Creates a new ChildEventContent.

Trait Implementations

impl Clone for ChildEventContent

fn clone(&self) -> ChildEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChildEventContent

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

Formats the value using the given formatter.

impl Default for ChildEventContent

fn default() -> ChildEventContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChildEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for ChildEventContent

fn event_type(&self) -> &str

A matrix event identifier, like m.room.message.

fn from_parts(ev_type: &str, content: &RawValue) -> Result<Self>

Constructs the given event content.

impl RedactContent for ChildEventContent

type Redacted = RedactedChildEventContent

The redacted form of the event’s content.

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

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

impl Serialize for ChildEventContent

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 ChildEventContent