Struct matrix_sdk_ui::room_list_service::RoomListService

pub struct RoomListService { /* private fields */ }

The RoomListService type. See the module’s documentation to learn more.

Implementations

impl RoomListService

pub async fn new(client: Client) -> Result<Self, Error>

Create a new RoomList.

A matrix_sdk::SlidingSync client will be created, with a cached list already pre-configured.

This won’t start an encryption sync, and it’s the user’s responsibility to create one in this case using EncryptionSync.

pub async fn new_with_encryption(client: Client) -> Result<Self, Error>

Create a new RoomList that enables encryption.

This will include syncing the encryption information, so there must not be any instance of EncryptionSync running in the background.

pub fn sync_indicator( &self, delay_before_showing: Duration, delay_before_hiding: Duration, ) -> impl Stream<Item = SyncIndicator>

Get a Stream of SyncIndicator.

Read the documentation of SyncIndicator to learn more about it.

pub fn client(&self) -> &Client

Get the Client that has been used to create Self.

pub fn state(&self) -> Subscriber<State>

Get a subscriber to the state.

pub async fn all_rooms(&self) -> Result<RoomList, Error>

Get a RoomList for all rooms.

pub fn room(&self, room_id: &RoomId) -> Result<Room, Error>

Get a Room if it exists.

pub fn subscribe_to_rooms( &self, room_ids: &[&RoomId], settings: Option<RoomSubscription>, )

Subscribe to rooms.

It means that all events from these rooms will be received every time, no matter how the RoomList is configured.

Trait Implementations

impl Debug for RoomListService

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

Formats the value using the given formatter.