Struct SqliteEventCacheStore

pub struct SqliteEventCacheStore { /* private fields */ }

Available on crate feature sqlite only.

An SQLite-based event cache store.

Implementations

impl SqliteEventCacheStore

pub async fn open( path: impl AsRef<Path>, passphrase: Option<&str>, ) -> Result<SqliteEventCacheStore, OpenStoreError>

Open the SQLite-based event cache store at the given path using the given passphrase to encrypt private data.

pub async fn open_with_config( config: SqliteStoreConfig, ) -> Result<SqliteEventCacheStore, OpenStoreError>

Open the SQLite-based event cache store with the config open config.

Trait Implementations

impl Clone for SqliteEventCacheStore

fn clone(&self) -> SqliteEventCacheStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteEventCacheStore

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

Formats the value using the given formatter.

impl EventCacheStore for SqliteEventCacheStore

type Error = Error

The error type used by this event cache store.

fn try_take_leased_lock<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, lease_duration_ms: u32, key: &'life1 str, holder: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteEventCacheStore: 'async_trait,

Try to take a lock using the given store.

fn handle_linked_chunk_updates<'life0, 'life1, 'async_trait>( &'life0 self, linked_chunk_id: LinkedChunkId<'life1>, updates: Vec<Update<TimelineEvent, Gap>>, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

An Update reflects an operation that has happened inside a linked chunk. The linked chunk is used by the event cache to store the events in-memory. This method aims at forwarding this update inside this store.

fn load_all_chunks_metadata<'life0, 'life1, 'async_trait>( &'life0 self, linked_chunk_id: LinkedChunkId<'life1>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ChunkMetadata>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Load all of the chunks’ metadata for the given LinkedChunkId.

fn load_last_chunk<'life0, 'life1, 'async_trait>( &'life0 self, linked_chunk_id: LinkedChunkId<'life1>, ) -> Pin<Box<dyn Future<Output = Result<(Option<RawChunk<TimelineEvent, Gap>>, ChunkIdentifierGenerator), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Load the last chunk of the LinkedChunk holding all events of the room identified by room_id.

fn load_previous_chunk<'life0, 'life1, 'async_trait>( &'life0 self, linked_chunk_id: LinkedChunkId<'life1>, before_chunk_identifier: ChunkIdentifier, ) -> Pin<Box<dyn Future<Output = Result<Option<RawChunk<TimelineEvent, Gap>>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Load the chunk before the chunk identified by before_chunk_identifier of the LinkedChunk holding all events of the room identified by room_id

fn clear_all_linked_chunks<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteEventCacheStore: 'async_trait,

Clear persisted events for all the rooms.

fn filter_duplicated_events<'life0, 'life1, 'async_trait>( &'life0 self, linked_chunk_id: LinkedChunkId<'life1>, events: Vec<OwnedEventId>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(OwnedEventId, Position)>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Given a set of event IDs, return the duplicated events along with their position if there are any.

fn find_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event_id: &'life2 EventId, ) -> Pin<Box<dyn Future<Output = Result<Option<TimelineEvent>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteEventCacheStore: 'async_trait,

Find an event by its ID in a room.

fn find_event_relations<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event_id: &'life2 EventId, filters: Option<&'life3 [RelationType]>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(TimelineEvent, Option<Position>)>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, SqliteEventCacheStore: 'async_trait,

Find all the events (alongside their position in the room’s linked chunk, if available) that relate to a given event.

fn get_room_events<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = Result<Vec<TimelineEvent>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Get all events in this room.

fn save_event<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event: TimelineEvent, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Save an event, that might or might not be part of an existing linked chunk.

fn remove_room<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Sync + 'async_trait,

Remove all data tied to a given room from the cache.