Struct RoomSummary

#[non_exhaustive]
pub struct RoomSummary {
    pub room_id: OwnedRoomId,
    pub canonical_alias: Option<OwnedRoomAliasId>,
    pub name: Option<String>,
    pub topic: Option<String>,
    pub avatar_url: Option<OwnedMxcUri>,
    pub room_type: Option<RoomType>,
    pub num_joined_members: UInt,
    pub join_rule: JoinRuleSummary,
    pub world_readable: bool,
    pub guest_can_join: bool,
    pub encryption: Option<EventEncryptionAlgorithm>,
    pub room_version: Option<RoomVersionId>,
}

The summary of a room’s state.

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.

room_id: OwnedRoomId

The ID of the room.

canonical_alias: Option<OwnedRoomAliasId>

The canonical alias of the room, if any.

If the compat-empty-string-null cargo feature is enabled, 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.

topic: Option<String>

The topic of the room, if any.

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.

room_type: Option<RoomType>

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

num_joined_members: UInt

The number of members joined to the room.

join_rule: JoinRuleSummary

The join rule of the room.

world_readable: bool

Whether the room may be viewed by 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.

encryption: Option<EventEncryptionAlgorithm>

If the room is encrypted, the algorithm used for this room.

room_version: Option<RoomVersionId>

The version of the room.

Implementations

impl RoomSummary

pub fn new( room_id: OwnedRoomId, join_rule: JoinRuleSummary, guest_can_join: bool, num_joined_members: UInt, world_readable: bool, ) -> Self

Construct a new RoomSummary with the given required fields.

Trait Implementations

impl Clone for RoomSummary

fn clone(&self) -> RoomSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomSummary

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PublicRoomsChunk> for RoomSummary

fn from(value: PublicRoomsChunk) -> Self

Converts to this type from the input type.

impl From<RoomSummary> for PublicRoomsChunk

fn from(value: RoomSummary) -> Self

Converts to this type from the input type.

impl Serialize for RoomSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.