Skip to main content

Module search_service

Module search_service 

Source
Available on crate feature experimental-search only.
Expand description

A reactive search service.

SearchService aggregates results of different kinds into a single reactive, paginated list of typed ResultTypes. Call SearchService::set_query to start (or restart) a search, then drive it page by page with SearchService::paginate, observing the results and the PaginationState as they change.

Today the only source is the SDK’s per-room message search; people, rooms and other kinds are expected to be added as further ResultType variants, and a matrix-sdk source can be swapped for a server-side one without changing this interface.

Structs§

MessageResult
A message matching a search query, with its content and sender resolved.
SearchService
A reactive, paginated search across all the user’s data.

Enums§

PaginationState
Whether the search service is currently loading a page of results.
ResultType
A single search result, tagged by the kind of entity it represents.