Struct JoinedRoom

#[non_exhaustive]
pub struct JoinedRoom {
    pub summary: RoomSummary,
    pub unread_notifications: UnreadNotificationsCount,
    pub unread_thread_notifications: BTreeMap<OwnedEventId, UnreadNotificationsCount>,
    pub timeline: Timeline,
    pub state: State,
    pub account_data: RoomAccountData,
    pub ephemeral: Ephemeral,
    pub unread_count: Option<UInt>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Updates to joined rooms.

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.

summary: RoomSummary

Information about the room which clients may need to correctly render it to users.

unread_notifications: UnreadNotificationsCount

Counts of unread notifications for this room.

If unread_thread_notifications was set to true in the RoomEventFilter, these include only the unread notifications for the main timeline.

unread_thread_notifications: BTreeMap<OwnedEventId, UnreadNotificationsCount>

Counts of unread notifications for threads in this room.

This is a map from thread root ID to unread notifications in the thread.

Only set if unread_thread_notifications was set to true in the RoomEventFilter.

timeline: Timeline

The timeline of messages and state changes in the room.

state: State

Updates to the state, between the time indicated by the since parameter, and the start of the timeline (or all state up to the start of the timeline, if since is not given, or full_state is true).

account_data: RoomAccountData

The private data that this user has attached to this room.

ephemeral: Ephemeral

The ephemeral events in the room that aren’t recorded in the timeline or state of the room.

unread_count: Option<UInt>

Available on crate feature unstable-msc2654 only.

The number of unread events since the latest read receipt.

This uses the unstable prefix in MSC2654.

Implementations

impl JoinedRoom

pub fn new() -> JoinedRoom

Creates an empty JoinedRoom.

pub fn is_empty(&self) -> bool

Returns true if there are no updates in the room.

Trait Implementations

impl Clone for JoinedRoom

fn clone(&self) -> JoinedRoom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JoinedRoom

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

Formats the value using the given formatter.

impl Default for JoinedRoom

fn default() -> JoinedRoom

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JoinedRoom

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JoinedRoom

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

where __S: Serializer,

Serialize this value into the given Serde serializer.