Struct ThreadListService 

pub struct ThreadListService { /* private fields */ }

A paginated list of threads for a given room.

ThreadListService provides an observable, paginated list of ThreadListItems. It exposes methods to paginate forward through the thread list as well as subscribe to state changes.

When created, the service automatically starts a background task that listens to room event cache updates (from /sync and other sources). Whenever a new event belonging to a known thread arrives, the service updates that thread’s latest_event and num_replies fields in real time, emitting observable diffs to all subscribers.

Example

use matrix_sdk::Room;
use matrix_sdk_ui::timeline::thread_list_service::{
    ThreadListPaginationState, ThreadListService,
};

let service = ThreadListService::new(room);

assert_eq!(
    service.pagination_state(),
    ThreadListPaginationState::Idle { end_reached: false }
);

service.paginate().await.unwrap();

let items = service.items();

Implementations

impl ThreadListService

pub fn new(room: Room) -> Self

Creates a new ThreadListService for the given room.

This immediately spawns a background task that listens to the room’s event cache for live updates. The task self-bootstraps by performing the async event cache subscription internally.

pub fn pagination_state(&self) -> ThreadListPaginationState

Returns the current pagination state.

pub fn subscribe_to_pagination_state_updates( &self, ) -> Subscriber<ThreadListPaginationState>

Subscribes to pagination state updates.

The returned Subscriber will emit a new value every time the pagination state changes.

pub fn items(&self) -> Vec<ThreadListItem>

Returns the current list of thread items as a snapshot.

pub fn subscribe_to_items_updates( &self, ) -> (Vector<ThreadListItem>, VectorSubscriberBatchedStream<ThreadListItem>)

Subscribes to updates of the thread item list.

Returns a snapshot of the current items alongside a batched stream of eyeball_im::VectorDiffs that describe subsequent changes.

pub async fn paginate(&self) -> Result<(), ThreadListServiceError>

Fetches the next page of threads, appending the results to the item list.

• If the list is already loading or the end has been reached, this method returns immediately with Ok(()).
• On a network/SDK error the pagination state is reset to Idle { end_reached: false } and the error is propagated.

pub async fn reset(&self)

Resets the service back to its initial state.

Clears all loaded items, discards the current pagination token, and sets the pagination state to Idle { end_reached: false }. The next call to Self::paginate will therefore start from the beginning of the thread list.