Struct SqliteEventCacheStore

pub struct SqliteEventCacheStore { /* private fields */ }

Available on crate feature sqlite only.

A 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_pool( pool: Pool<Manager>, passphrase: Option<&str>, ) -> Result<SqliteEventCacheStore, OpenStoreError>

Open an SQLite-based event cache store using the given SQLite database pool. The given passphrase will be used to encrypt private data.

Trait Implementations

impl Clone for SqliteEventCacheStore

fn clone(&self) -> SqliteEventCacheStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteEventCacheStore

Available on non-tarpaulin_include only.

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, room_id: &'life1 RoomId, updates: Vec<Update<SyncTimelineEvent, 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 reload_linked_chunk<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = Result<Vec<RawChunk<SyncTimelineEvent, Gap>>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

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

Return all the raw components of a linked chunk, so the caller may reconstruct the linked chunk later.

fn clear_all_rooms_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 add_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, content: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Add a media file’s content in the media store.

fn replace_media_key<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 MediaRequestParameters, to: &'life2 MediaRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

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

Replaces the given media’s content key with another one.

fn get_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, Error>> + Send + 'async_trait>>

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

Get a media file’s content out of the media store.

fn remove_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Remove a media file’s content from the media store.

fn get_media_content_for_uri<'life0, 'life1, 'async_trait>( &'life0 self, uri: &'life1 MxcUri, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>

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

Get a media file’s content associated to an MxcUri from the media store.

fn remove_media_content_for_uri<'life0, 'life1, 'async_trait>( &'life0 self, uri: &'life1 MxcUri, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Remove all the media files’ content associated to an MxcUri from the media store.