Struct SpaceService

pub struct SpaceService { /* private fields */ }

The main entry point into the Spaces facilities.

The spaces service is responsible for retrieving one’s joined rooms, building a graph out of their m.space.parent and m.space.child state events, and providing access to the top-level spaces and their children.

Examples

use futures_util::StreamExt;
use matrix_sdk::Client;
use matrix_sdk_ui::spaces::SpaceService;
use ruma::owned_room_id;

let space_service = SpaceService::new(client.clone());

// Get a list of all the joined spaces
let joined_spaces = space_service.joined_spaces().await;

// And subscribe to changes on them
// `initial_values` is equal to `joined_spaces` if nothing changed meanwhile
let (initial_values, stream) =
    space_service.subscribe_to_joined_spaces().await;

while let Some(diffs) = stream.next().await {
    println!("Received joined spaces updates: {diffs:?}");
}

// Get a list of all the rooms in a particular space
let room_list = space_service
    .space_room_list(owned_room_id!("!some_space:example.org"));

// Which can be used to retrieve information about the children rooms
let children = room_list.rooms();

Implementations

impl SpaceService

pub fn new(client: Client) -> Self

Creates a new SpaceService instance.

pub async fn subscribe_to_joined_spaces( &self, ) -> (Vector<SpaceRoom>, VectorSubscriberBatchedStream<SpaceRoom>)

Subscribes to updates on the joined spaces list. If space rooms are joined or left, the stream will yield diffs that reflect the changes.

pub async fn joined_spaces(&self) -> Vec<SpaceRoom>

Returns a list of all the top-level joined spaces. It will eagerly compute the latest version and also notify subscribers if there were any changes.

pub fn space_room_list(&self, space_id: OwnedRoomId) -> SpaceRoomList

Returns a SpaceRoomList for the given space ID.