Struct matrix_sdk_base::ruma::api::client::sync::sync_events::v5::response::Room

source ·
#[non_exhaustive]
pub struct Room {
Show 15 fields 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 feature api and (crate features client or server) and crate feature unstable-msc4186 only.
Expand description

A slising sync response updated room (see super::Response::rooms).

Fields (Non-exhaustive)§

This struct is marked as 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§

source§

impl Room

source

pub fn new() -> Room

Available on crate feature experimental-sliding-sync only.

Creates an empty Room.

Trait Implementations§

source§

impl Clone for Room

source§

fn clone(&self) -> Room

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Room

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Room

source§

fn default() -> Room

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<SlidingSyncRoom> for Room

source§

fn from(value: SlidingSyncRoom) -> Room

Converts to this type from the input type.
source§

impl Serialize for Room

source§

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. Read more

Auto Trait Implementations§

§

impl Freeze for Room

§

impl RefUnwindSafe for Room

§

impl Send for Room

§

impl Sync for Room

§

impl Unpin for Room

§

impl UnwindSafe for Room

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,