Struct RoomList 

#[repr(transparent)]
pub struct RoomList {
    inner: TypedObjectRef<RoomList, ()>,
    phantom: PhantomData<()>,
}

List of all rooms known by the user.

This is the parent GListModel of the sidebar from which all other models are derived.

The RoomList also takes care of, so called pending rooms, i.e. rooms the user requested to join, but received no response from the server yet.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<RoomList, ()>

phantom: PhantomData<()>

Implementations

impl RoomList

pub fn session(&self) -> <WeakRef<Session> as Property>::Value

The current session.

pub fn connect_session_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the session property

pub fn notify_session(&self)

Notify listeners of a change in the session property

impl RoomList

pub fn new(session: &Session) -> Self

pub(crate) async fn load(&self)

Load the list of rooms from the Store.

pub(crate) fn snapshot(&self) -> Vec<Room>

Get a snapshot of the rooms list.

pub(crate) fn is_joining_room(&self, identifier: &RoomOrAliasId) -> bool

Whether we are currently joining the room with the given identifier.

pub(crate) fn get(&self, room_id: &RoomId) -> Option<Room>

Get the room with the given room ID, if any.

pub(crate) fn get_by_identifier( &self, identifier: &RoomOrAliasId, ) -> Option<Room>

Get the room with the given identifier, if any.

pub(crate) async fn get_wait( &self, room_id: &RoomId, timeout: Option<Duration>, ) -> Option<Room>

Wait till the room with the given ID becomes available.

pub(crate) fn direct_chat(&self, user_id: &UserId) -> Option<Room>

Get the joined room that is a direct chat with the user with the given ID.

If several rooms are found, returns the room with the latest activity.

pub(crate) fn add_tombstoned_room(&self, room_id: OwnedRoomId)

Add a room that was tombstoned but for which we haven’t joined the successor yet.

pub(crate) fn handle_room_updates(&self, rooms: RoomUpdates)

Handle room updates received via sync.

pub(crate) async fn join_by_id_or_alias( &self, identifier: OwnedRoomOrAliasId, via: Vec<OwnedServerName>, ) -> Result<OwnedRoomId, String>

Join the room with the given identifier.

pub(crate) async fn knock( &self, identifier: OwnedRoomOrAliasId, via: Vec<OwnedServerName>, ) -> Result<OwnedRoomId, String>

Request an invite to the room with the given identifier.

pub fn connect_joining_rooms_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the list of rooms we are currently joining changed.

Trait Implementations

impl Clone for RoomList

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for RoomList

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

Formats the value using the given formatter.

impl HasParamSpec for RoomList

type ParamSpec = ParamSpecObject

type SetValue = RoomList

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, RoomList>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for RoomList

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for RoomList

type Subclass = RoomList

impl Ord for RoomList

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for RoomList

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for RoomList

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for RoomList

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for RoomList

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for RoomList

impl IsA<ListModel> for RoomList