Struct RoomDirectorySearch

pub struct RoomDirectorySearch { /* private fields */ }

RoomDirectorySearch allows searching the public room directory, with the capability of using a filter and a batch_size. This struct is also responsible for keeping the current state of the search, and exposing an update of stream of the results, reset the search, or ask for the next page.

⚠️ Users must take great care when using the public room search since the results might contains NSFW content.

Example

use matrix_sdk::{room_directory_search::RoomDirectorySearch, Client};
use url::Url;

async {
    let homeserver = Url::parse("http://localhost:8080")?;
    let client = Client::new(homeserver).await?;
    let mut room_directory_search = RoomDirectorySearch::new(client);
    room_directory_search.search(None, 10, None).await?;
    let (results, mut stream) = room_directory_search.results();
    room_directory_search.next_page().await?;
    anyhow::Ok(())
};

Implementations

impl RoomDirectorySearch

pub fn new(client: Client) -> Self

Constructor for the RoomDirectorySearch, requires a Client.

pub async fn search( &mut self, filter: Option<String>, batch_size: u32, via_server: Option<OwnedServerName>, ) -> Result<()>

Starts a filtered search for the server.

If the filter is not provided it will search for all the rooms. You can specify a batch_size to control the number of rooms to fetch per request.

If the via_server is not provided it will search in the current homeserver by default.

This method will clear the current search results and start a new one.

pub async fn next_page(&mut self) -> Result<()>

Asks the server for the next page of the current search.

pub fn results( &self, ) -> (Vector<RoomDescription>, impl Stream<Item = Vec<VectorDiff<RoomDescription>>>)

Get the initial values of the current stored room descriptions in the search, and a stream of updates for them.

pub fn loaded_pages(&self) -> usize

Get the number of pages that have been loaded so far.

pub fn is_at_last_page(&self) -> bool

Get whether the search is at the last page.

Trait Implementations

impl Debug for RoomDirectorySearch

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

Formats the value using the given formatter.