Struct RoomList

pub struct RoomList {
    pub(super) list: RefCell<IndexMap<OwnedRoomId, Room>>,
    pub(super) joining_rooms: RefCell<HashSet<OwnedRoomOrAliasId>>,
    tombstoned_rooms: RefCell<HashSet<OwnedRoomId>>,
    session: WeakRef<Session>,
    metainfo: RoomListMetainfo,
    pub(super) get_wait_source: RefCell<Option<SourceId>>,
}

Fields

list: RefCell<IndexMap<OwnedRoomId, Room>>

The list of rooms.

joining_rooms: RefCell<HashSet<OwnedRoomOrAliasId>>

The list of rooms we are currently joining.

tombstoned_rooms: RefCell<HashSet<OwnedRoomId>>

The list of rooms that were upgraded and for which we have not joined the successor yet.

session: WeakRef<Session>

The current session.

metainfo: RoomListMetainfo

The rooms metainfo that allow to restore this RoomList from its previous state.

get_wait_source: RefCell<Option<SourceId>>

Implementations

impl RoomList

fn register_type()

Registers the type only once.

impl RoomList

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

impl RoomList

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

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

fn contains(&self, room_id: &RoomId) -> bool

Whether this list contains the room with the given ID.

fn remove_joining_room(&self, identifier: &RoomOrAliasId)

Remove the given room identifier from the rooms we are currently joining.

fn add_joining_room(&self, identifier: OwnedRoomOrAliasId)

Add the given room identified to the rooms we are currently joining.

fn remove_or_replace_joining_room( &self, identifier: &RoomOrAliasId, room_id: &RoomId, )

Remove the given room identifier from the rooms we are currently joining and replace it with the given room ID if the room is not in the list yet.

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

Add a room that was tombstoned but for which we have not joined the successor yet.

fn items_added(&self, added: usize)

Handle when items were added to the list.

fn remove(&self, room_id: &RoomId)

Remove the room with the given ID.

pub(super) async fn load(&self)

Load the list of rooms from the Store.

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

Handle room updates received via sync.

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

Join the room with the given identifier.

Trait Implementations

impl Debug for RoomList

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

Formats the value using the given formatter.

impl Default for RoomList

fn default() -> RoomList

Returns the “default value” for a type.

impl DerivedObjectProperties for RoomList

fn derived_properties() -> &'static [ParamSpec]

Properties installed for this type.

fn derived_property(&self, id: usize, pspec: &ParamSpec) -> Value

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

fn derived_set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

impl ListModelImpl for RoomList

fn item_type(&self) -> Type

fn n_items(&self) -> u32

fn item(&self, position: u32) -> Option<Object>

impl ObjectImpl for RoomList

fn signals() -> &'static [Signal]

Signals installed for this type.

fn constructed(&self)

Constructed.

fn dispose(&self)

Disposes of the object.

fn properties() -> &'static [ParamSpec]

Properties installed for this type.

fn set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Property setter.

fn property(&self, id: usize, pspec: &ParamSpec) -> Value

Property getter.

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

impl ObjectSubclass for RoomList

const NAME: &'static str = "RoomList"

GObject type name.

type ParentType = Object

Parent Rust type to inherit from.

type Class = ClassStruct<RoomList>

The C class struct.

type Instance = InstanceStruct<RoomList>

The C instance struct.

type Type = RoomList

Wrapper around this subclass defined with wrapper!

type Interfaces = (ListModel,)

List of interfaces implemented by this type.

fn new() -> Self

Constructor.

const ABSTRACT: bool = false

If this subclass is an abstract class or not.

const ALLOW_NAME_CONFLICT: bool = false

Allow name conflicts for this class.

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization.

fn class_init(_klass: &mut Self::Class)

Class initialization.

fn with_class(_klass: &Self::Class) -> Self

Constructor.

fn instance_init(_obj: &InitializingObject<Self>)

Performs additional instance initialization.

impl ObjectSubclassType for RoomList

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.

fn type_() -> Type

Returns the glib::Type ID of the subclass.