Enum RoomLoadSettings

pub enum RoomLoadSettings {
    All,
    One(OwnedRoomId),
}

Configure how many rooms will be restored when restoring the session with BaseStateStore::load_rooms.

⚠️ Be careful!

When loading a single room with RoomLoadSettings::One, the in-memory state may not reflect the store state (in the databases). Thus, when one will get a room that exists in the store state but not in the in-memory state, it will be created from scratch and, when saved, will override the data in the store state (in the databases). This can lead to weird behaviours.

This option is expected to be used as follows:

1. Create a BaseStateStore with a StateStore based on SQLite for example,
2. Restore a session and load one room from the StateStore (in the case of dealing with a notification for example),
3. Derive the BaseStateStore, with BaseStateStore::derive_from_other, into another one with an in-memory StateStore, such as MemoryStore,
4. Work on this derived BaseStateStore.

Now, all operations happen in the MemoryStore, not on the original store (SQLite in this example), thus protecting original data.

From a higher-level point of view, this is what BaseClient::clone_with_in_memory_state_store does.

Variants

All

Load all rooms from the StateStore into the in-memory state store BaseStateStore.

This is the default variant.

One(OwnedRoomId)

Load a single room from the StateStore into the in-memory state store BaseStateStore.

Please, be careful with this option. Read the documentation of RoomLoadSettings.

Trait Implementations

impl Clone for RoomLoadSettings

fn clone(&self) -> RoomLoadSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomLoadSettings

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

Formats the value using the given formatter.

impl Default for RoomLoadSettings

fn default() -> RoomLoadSettings

Returns the “default value” for a type.