Skip to content

doc(ui): Improve documentation of RoomListLoadingState #5880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2025
Merged

doc(ui): Improve documentation of RoomListLoadingState #5880

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions crates/matrix-sdk-ui/src/room_list_service/room_list.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ impl RoomList {
/// Get a subscriber to the room list loading state.
///
/// This method will send out the current loading state as the first update.
///
/// See [`RoomListLoadingState`].
pub fn loading_state(&self) -> Subscriber<RoomListLoadingState> {
self.loading_state.subscribe_reset()
}
Expand Down Expand Up @@ -285,6 +287,8 @@ fn merge_stream_and_receiver(
/// When a [`RoomList`] is displayed to the user, it can be in various states.
/// This enum tries to represent those states with a correct level of
/// abstraction.
///
/// See [`RoomList::loading_state`].
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum RoomListLoadingState {
/// The [`RoomList`] has not been loaded yet, i.e. a sync might run
Expand All @@ -309,8 +313,8 @@ pub enum RoomListLoadingState {
/// The maximum number of rooms a [`RoomList`] contains.
///
/// It does not mean that there are exactly this many rooms to display.
/// Usually, the room entries are represented by [`Room`]. The room
/// entry might have been synced or not synced yet, but we know for sure
/// The room entries are represented by [`RoomListItem`]. The room entry
/// might have been synced or not synced yet, but we know for sure
/// (from the server), that there will be this amount of rooms in the
/// list at the end.
///
Expand Down
Loading