Struct ruma_client_api::sync::sync_events::v4::SlidingSyncRoom

pub struct SlidingSyncRoom {

    pub name: Option<String>,
    pub avatar: Option<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 timestamp: Option<MilliSecondsSinceUnixEpoch>,
}

Available on (crate features client or server) and crate feature unstable-msc3575 only.

Updates to joined rooms.

Fields

name: Option<String>

The name of the room as calculated by the server.

avatar: Option<OwnedMxcUri>

The avatar of the room.

initial: Option<bool>

Was this an initial response.

is_dm: Option<bool>

This is a direct message.

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

Counts of unread notifications for this room.

timeline: Vec<Raw<AnySyncTimelineEvent>>

The timeline of messages and state changes in the room.

required_state: Vec<Raw<AnySyncStateEvent>>

Updates to the state at the beginning of the timeline. A list of state events.

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.

timestamp: Option<MilliSecondsSinceUnixEpoch>

The timestamp of the room.

It’s not to be confused with origin_server_ts of the latest event in the timeline. bump_event_types might “ignore” some events when computing the timestamp of the room. Thus, using this timestamp value is more accurate than relying on the latest event.

Implementations

impl SlidingSyncRoom

pub fn new() -> Self

Creates an empty Room.

Trait Implementations

impl Clone for SlidingSyncRoom

fn clone(&self) -> SlidingSyncRoom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingSyncRoom

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

Formats the value using the given formatter.

impl Default for SlidingSyncRoom

fn default() -> SlidingSyncRoom

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SlidingSyncRoom

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SlidingSyncRoom

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

Serialize this value into the given Serde serializer.