Struct RoomIndex

pub struct RoomIndex { /* private fields */ }

A struct that holds all data pertaining to a particular room’s message index.

Implementations

impl RoomIndex

pub fn new(path: &Path, room_id: &RoomId) -> Result<RoomIndex, IndexError>

Create new RoomIndex which stores the index in path/room_id

pub fn new_in_memory(room_id: &RoomId) -> Result<RoomIndex, IndexError>

Create new RoomIndex which stores the index in memory. Intended for testing.

pub fn open_or_create( path: &Path, room_id: &RoomId, ) -> Result<RoomIndex, IndexError>

Open index at path/room_id if it exists else create new RoomIndex which stores the index in path/room_id

pub fn open(path: &Path, room_id: &RoomId) -> Result<RoomIndex, IndexError>

Open index at path/room_id. Fails if it doesn’t exist.

pub fn handle_event( &mut self, event: AnySyncMessageLikeEvent, ) -> Result<(), IndexError>

Handle [AnySyncMessageLikeEvent]

This which will add/remove/edit an event in the index based on the event type.

pub fn commit(&mut self) -> Result<OpStamp, IndexError>

Commit added events to RoomIndex

pub fn commit_and_reload(&mut self) -> Result<OpStamp, IndexError>

Commit added events to RoomIndex and update searchers so that they reflect the state of the last .commit().

Every commit should be rapidly reflected on your IndexReader and you should not need to call reload() at all.

This automatic reload can take 10s of milliseconds to kick in however, and in unit tests it can be nice to deterministically force the reload of searchers.

pub fn search( &self, query: &str, max_number_of_results: usize, ) -> Result<Vec<OwnedEventId>, IndexError>

Search the RoomIndex for some query. Returns a list of results with a maximum given length.

Trait Implementations

impl Debug for RoomIndex

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

Formats the value using the given formatter.