Struct matrix_sdk :: RoomInfo Copy item path

impl RoomInfo

pub fn mark_as_joined(&mut self)

Mark this Room as joined.

pub fn mark_as_left(&mut self)

Mark this Room as left.

pub fn mark_as_invited(&mut self)

Mark this Room as invited.

pub fn mark_as_knocked(&mut self)

Mark this Room as knocked.

pub fn set_state(&mut self, room_state: RoomState)

Set the membership RoomState of this Room

pub fn mark_members_synced(&mut self)

Mark this Room as having all the members synced.

pub fn mark_members_missing(&mut self)

Mark this Room as still missing member information.

pub fn mark_state_partially_synced(&mut self)

Mark this Room as still missing some state information.

pub fn mark_state_fully_synced(&mut self)

Mark this Room as still having all state synced.

pub fn mark_state_not_synced(&mut self)

Mark this Room as still having no state synced.

pub fn mark_encryption_state_synced(&mut self)

Mark this Room as having the encryption state synced.

pub fn mark_encryption_state_missing(&mut self)

Mark this Room as still missing encryption state information.

pub fn set_prev_batch(&mut self, prev_batch: Option<&str>) -> bool

Set the prev_batch-token. Returns whether the token has differed and thus has been upgraded: false means no update was applied as the were the same

pub fn state(&self) -> RoomState

Returns the state this room is in.

pub fn is_encrypted(&self) -> bool

Returns whether this is an encrypted room.

pub fn set_encryption_event( &mut self, event: Option<RoomEncryptionEventContent>, )

Set the encryption event content in this room.

pub fn handle_state_event(&mut self, event: &AnySyncStateEvent) -> bool

Handle the given state event.

Returns true if the event modified the info, false otherwise.

pub fn handle_stripped_state_event( &mut self, event: &AnyStrippedStateEvent, ) -> bool

Handle the given stripped state event.

Returns true if the event modified the info, false otherwise.

pub fn handle_redaction( &mut self, event: &SyncRoomRedactionEvent, _raw: &Raw<SyncRoomRedactionEvent>, )

Handle the given redaction.

pub fn avatar_url(&self) -> Option<&MxcUri>

Returns the current room avatar.

pub fn update_avatar(&mut self, url: Option<OwnedMxcUri>)

Update the room avatar.

pub fn avatar_info(&self) -> Option<&ImageInfo>

Returns information about the current room avatar.

pub fn update_notification_count( &mut self, notification_counts: UnreadNotificationsCount, )

Update the notifications count.

pub fn update_from_ruma_summary(&mut self, summary: &RoomSummary) -> bool

Update the RoomSummary from a Ruma RoomSummary.

Returns true if any field has been updated, false otherwise.

pub fn heroes(&self) -> &[RoomHero]

The heroes for this room.

pub fn active_members_count(&self) -> u64

The number of active members (invited + joined) in the room.

The return value is saturated at u64::MAX.

pub fn invited_members_count(&self) -> u64

The number of invited members in the room

pub fn joined_members_count(&self) -> u64

The number of joined members in the room

pub fn canonical_alias(&self) -> Option<&RoomAliasId>

Get the canonical alias of this room.

pub fn alt_aliases(&self) -> &[OwnedRoomAliasId]

Get the alternative aliases of this room.

pub fn room_id(&self) -> &RoomId

Get the room ID of this room.

pub fn room_version(&self) -> Option<&RoomVersionId>

Get the room version of this room.

pub fn room_version_or_default(&self) -> RoomVersionId

Get the room version of this room, or a sensible default.

Will warn (at most once) if the room creation event is missing from this RoomInfo.

pub fn room_type(&self) -> Option<&RoomType>

Get the room type of this room.

pub fn creator(&self) -> Option<&UserId>

Get the creator of this room.

pub fn history_visibility(&self) -> &HistoryVisibility

Returns the history visibility for this room.

Defaults to WorldReadable, if missing.

pub fn join_rule(&self) -> &JoinRule

Returns the join rule for this room.

Defaults to Public, if missing.

pub fn name(&self) -> Option<&str>

Get the name of this room.

pub fn topic(&self) -> Option<&str>

Returns the topic for this room, if set.

pub fn has_active_room_call(&self) -> bool

Is there a non expired membership with application “m.call” and scope “m.room” in this room.

pub fn active_room_call_participants(&self) -> Vec<OwnedUserId>

Returns a Vec of userId’s that participate in the room call.

matrix_rtc memberships with application “m.call” and scope “m.room” are considered. A user can occur twice if they join with two devices. convert to a set depending if the different users are required or the amount of sessions.

The vector is ordered by oldest membership user to newest.

pub fn latest_event(&self) -> Option<&LatestEvent>

Available on crate feature experimental-sliding-sync only.

Returns the latest (decrypted) event recorded for this room.

pub fn pinned_event_ids(&self) -> Option<Vec<OwnedEventId>>

Returns the current pinned event ids for this room.

pub fn is_pinned_event(&self, event_id: &EventId) -> bool

Checks if an EventId is currently pinned. It avoids having to clone the whole list of event ids to check a single value.

Returns true if the provided event_id is pinned, false otherwise.

Trait Implementations§

impl Clone for RoomInfo

fn clone(&self) -> RoomInfo

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

impl Debug for RoomInfo

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for RoomInfo

fn deserialize<D>( deserializer: D, ) -> Result<RoomInfo, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for RoomInfo

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 UnwindSafe for RoomInfo

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

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

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

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

Consume a handle, getting back the initial Arc<>

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

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

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

const WITNESS: W = W::MAKE

A constant of the type witness

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>).

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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