Struct Room

#[non_exhaustive]
pub struct Room {

    pub name: Option<String>,
    pub avatar: JsOption<OwnedMxcUri>,
    pub initial: Option<bool>,
    pub is_dm: Option<bool>,
    pub invite_state: Option<Vec<Raw<AnyStrippedStateEvent>>>,
    pub unread_notifications: UnreadNotificationsCount,
    pub timeline: Vec<Raw<AnySyncTimelineEvent>>,
    pub required_state: Vec<Raw<AnySyncStateEvent>>,
    pub prev_batch: Option<String>,
    pub limited: bool,
    pub joined_count: Option<UInt>,
    pub invited_count: Option<UInt>,
    pub num_live: Option<UInt>,
    pub bump_stamp: Option<UInt>,
    pub heroes: Option<Vec<Hero>>,
}

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

A slising sync response updated room (see super::Response::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.

name: Option<String>

The name as calculated by the server.

avatar: JsOption<OwnedMxcUri>

The avatar.

initial: Option<bool>

Whether it is an initial response.

is_dm: Option<bool>

Whether it is a direct room.

invite_state: Option<Vec<Raw<AnyStrippedStateEvent>>>

If this is Some(_), this is a not-yet-accepted invite containing the given stripped state events.

unread_notifications: UnreadNotificationsCount

Number of unread notifications.

timeline: Vec<Raw<AnySyncTimelineEvent>>

Message-like events and live state events.

required_state: Vec<Raw<AnySyncStateEvent>>

State events as configured by the request.

prev_batch: Option<String>

The prev_batch allowing you to paginate through the messages before the given ones.

limited: bool

True if the number of events returned was limited by the limit on the filter.

joined_count: Option<UInt>

The number of users with membership of join, including the client’s own user ID.

invited_count: Option<UInt>

The number of users with membership of invite.

num_live: Option<UInt>

The number of timeline events which have just occurred and are not historical.

bump_stamp: Option<UInt>

The bump stamp of the room.

It can be interpreted as a “recency stamp” or “streaming order index”. For example, consider roomA with bump_stamp = 2, roomB with bump_stamp = 1 and roomC with bump_stamp = 0. If roomC receives an update, its bump_stamp will be 3.

heroes: Option<Vec<Hero>>

Heroes of the room, if requested.

Implementations

impl Room

pub fn new() -> Room

Creates an empty Room.

Trait Implementations

impl Clone for Room

fn clone(&self) -> Room

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Room

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

Formats the value using the given formatter.

impl Default for Room

fn default() -> Room

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Room

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SlidingSyncRoom> for Room

fn from(value: SlidingSyncRoom) -> Room

Converts to this type from the input type.

impl Serialize for Room

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.