matrix_sdk

Struct SqliteEventCacheStore

Source 
pub struct SqliteEventCacheStore { /* private fields */ }
Available on crate feature sqlite only.
Expand description

An SQLite-based event cache store.

Implementations§

Source§

impl SqliteEventCacheStore

Source

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.

Source

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§

Source§

impl Clone for SqliteEventCacheStore

Source§

fn clone(&self) -> SqliteEventCacheStore

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SqliteEventCacheStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl EventCacheStore for SqliteEventCacheStore

Source§

type Error = Error

The error type used by this event cache store.
Source§

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.
Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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 Read more
Source§

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. Read more
Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn add_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, content: Vec<u8>, ignore_policy: IgnoreMediaRetentionPolicy, ) -> 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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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

Set the MediaRetentionPolicy to use for deciding whether to store or keep media content. Read more
Source§

fn media_retention_policy(&self) -> MediaRetentionPolicy

Get the current MediaRetentionPolicy.
Source§

fn set_ignore_media_retention_policy<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStore>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Set whether the current MediaRetentionPolicy should be ignored for the media. Read more
Source§

fn clean_up_media_cache<'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,

Clean up the media cache with the current MediaRetentionPolicy. Read more
Source§

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.
Source§

impl EventCacheStoreMedia for SqliteEventCacheStore

Source§

type Error = Error

The error type used by this media cache store.
Source§

fn media_retention_policy_inner<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<MediaRetentionPolicy>, <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteEventCacheStore: 'async_trait,

The persisted media retention policy in the media cache.
Source§

fn set_media_retention_policy_inner<'life0, 'async_trait>( &'life0 self, policy: MediaRetentionPolicy, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteEventCacheStore: 'async_trait,

Persist the media retention policy in the media cache. Read more
Source§

fn add_media_content_inner<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, data: Vec<u8>, last_access: SystemTime, policy: MediaRetentionPolicy, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Add a media file’s content in the media cache. Read more
Source§

fn set_ignore_media_retention_policy_inner<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Set whether the current MediaRetentionPolicy should be ignored for the media. Read more
Source§

fn get_media_content_inner<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequestParameters, current_time: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteEventCacheStore: 'async_trait,

Get a media file’s content out of the media cache. Read more
Source§

fn get_media_content_for_uri_inner<'life0, 'life1, 'async_trait>( &'life0 self, uri: &'life1 MxcUri, current_time: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, <SqliteEventCacheStore as EventCacheStoreMedia>::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. Read more
Source§

fn clean_up_media_cache_inner<'life0, 'async_trait>( &'life0 self, policy: MediaRetentionPolicy, current_time: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteEventCacheStore: 'async_trait,

Clean up the media cache with the given policy. Read more
Source§

fn last_media_cleanup_time_inner<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<SystemTime>, <SqliteEventCacheStore as EventCacheStoreMedia>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteEventCacheStore: 'async_trait,

The time of the last media cache cleanup.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Store> EventCacheStoreMediaIntegrationTests for Store
where Store: EventCacheStoreMedia + Debug,

Source§

async fn test_store_media_retention_policy(&self)

Test media retention policy storage.
Source§

async fn test_media_max_file_size(&self)

Test media content’s retention policy max file size.
Source§

async fn test_media_max_cache_size(&self)

Test media content’s retention policy max cache size.
Source§

async fn test_media_expiry(&self)

Test media content’s retention policy expiry.
Source§

async fn test_media_ignore_max_size(&self)

Test IgnoreMediaRetentionPolicy with the media content’s retention policy max sizes.
Source§

async fn test_media_ignore_expiry(&self)

Test IgnoreMediaRetentionPolicy with the media content’s retention policy expiry.
Source§

async fn test_store_last_media_cleanup_time(&self)

Test last media cleanup time storage.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
Source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoEventCacheStore for T
where T: EventCacheStore + 'static,

Source§

fn into_event_cache_store( self, ) -> Arc<dyn EventCacheStore<Error = EventCacheStoreError>>

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

Source§

impl<T> CloneAny for T
where T: Any + Clone,

Source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

Source§

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> JsonCastable<CanonicalJsonValue> for T

§

impl<T> JsonCastable<Value> for T

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> SendOutsideWasm for T
where T: Send,

Source§

impl<T> SyncOutsideWasm for T
where T: Sync,