Struct ruma_federation_api::space::SpaceHierarchyParentSummary

pub struct SpaceHierarchyParentSummary {
    pub canonical_alias: Option<OwnedRoomAliasId>,
    pub name: Option<String>,
    pub num_joined_members: UInt,
    pub room_id: OwnedRoomId,
    pub topic: Option<String>,
    pub world_readable: bool,
    pub guest_can_join: bool,
    pub avatar_url: Option<OwnedMxcUri>,
    pub join_rule: SpaceRoomJoinRule,
    pub room_type: Option<RoomType>,
    pub children_state: Vec<Raw<HierarchySpaceChildEvent>>,
    pub allowed_room_ids: Vec<OwnedRoomId>,
}

The summary of a parent space.

To create an instance of this type, first create a SpaceHierarchyParentSummaryInit and convert it via SpaceHierarchyParentSummary::from / .into().

Fields

canonical_alias: Option<OwnedRoomAliasId>

The canonical alias of the room, if any.

If you activate the compat-empty-string-null feature, this field being an empty string in JSON will result in None here during deserialization.

name: Option<String>

The name of the room, if any.

num_joined_members: UInt

The number of members joined to the room.

room_id: OwnedRoomId

The ID of the room.

topic: Option<String>

The topic of the room, if any.

world_readable: bool

Whether the room may be viewed by guest users without joining.

guest_can_join: bool

Whether guest users may join the room and participate in it.

If they can, they will be subject to ordinary power level rules like any other user.

avatar_url: Option<OwnedMxcUri>

The URL for the room’s avatar, if one is set.

If you activate the compat-empty-string-null feature, this field being an empty string in JSON will result in None here during deserialization.

join_rule: SpaceRoomJoinRule

The join rule of the room.

room_type: Option<RoomType>

The type of room from m.room.create, if any.

children_state: Vec<Raw<HierarchySpaceChildEvent>>

The stripped m.space.child events of the space-room.

If the room is not a space-room, this should be empty.

allowed_room_ids: Vec<OwnedRoomId>

If the room is a restricted room, these are the room IDs which are specified by the join rules.

Trait Implementations

impl Clone for SpaceHierarchyParentSummary

fn clone(&self) -> SpaceHierarchyParentSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpaceHierarchyParentSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpaceHierarchyParentSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpaceHierarchyParentSummary> for SpaceHierarchyChildSummary

fn from(parent: SpaceHierarchyParentSummary) -> Self

Converts to this type from the input type.

impl From<SpaceHierarchyParentSummaryInit> for SpaceHierarchyParentSummary

fn from(init: SpaceHierarchyParentSummaryInit) -> Self

Converts to this type from the input type.

impl Serialize for SpaceHierarchyParentSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.