pub struct SpaceChildEventContent {
    pub via: Vec<OwnedServerName>,
    pub order: Option<String>,
    pub suggested: bool,
}
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: 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: 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.

Defaults to false.

Implementations§

source§

impl SpaceChildEventContent

source

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

Creates a new SpaceChildEventContent with the given routing servers.

Trait Implementations§

source§

impl Clone for SpaceChildEventContent

source§

fn clone(&self) -> SpaceChildEventContent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SpaceChildEventContent

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl EventContent for SpaceChildEventContent

§

type EventType = StateEventType

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

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

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

impl From<SpaceChildEventContent> for AnyStateEventContent

source§

fn from(c: SpaceChildEventContent) -> Self

Converts to this type from the input type.
source§

impl RedactContent for SpaceChildEventContent

§

type Redacted = RedactedSpaceChildEventContent

The redacted form of the event’s content.
source§

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

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

impl Serialize for SpaceChildEventContent

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StateEventContent for SpaceChildEventContent

§

type StateKey = OwnedRoomId

The type of the event’s state_key field.
source§

impl StaticEventContent for SpaceChildEventContent

source§

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

The event type.
source§

impl StaticStateEventContent for SpaceChildEventContent

§

type PossiblyRedacted = PossiblyRedactedSpaceChildEventContent

The possibly redacted form of the event’s content.
§

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

The type of the event’s unsigned field.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> EventContentFromType for Twhere T: EventContent + DeserializeOwned,

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for Twhere W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for Twhere T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,