Struct SqliteMediaStore 

pub struct SqliteMediaStore { /* private fields */ }

Available on crate feature sqlite only.

An SQLite-based media store.

Implementations

impl SqliteMediaStore

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

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

pub async fn open_with_key( path: impl AsRef<Path>, key: Option<&[u8; 32]>, ) -> Result<SqliteMediaStore, OpenStoreError>

Open the SQLite-based media store at the given path using the given key to encrypt private data.

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

Open the SQLite-based media store with the config open config.

pub async fn vacuum(&self) -> Result<(), Error>

Trait Implementations

impl Clone for SqliteMediaStore

fn clone(&self) -> SqliteMediaStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteMediaStore

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.

impl MediaStore for SqliteMediaStore

type Error = Error

The error type used by this media 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<Option<u64>, Error>> + Send + 'async_trait>>

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

Try to take a lock using the given store.

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, SqliteMediaStore: '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<(), <SqliteMediaStore as MediaStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteMediaStore: '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, SqliteMediaStore: '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, SqliteMediaStore: '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>>, <SqliteMediaStore as MediaStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: '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, SqliteMediaStore: 'async_trait,

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

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

Set the MediaRetentionPolicy to use for deciding whether to store or keep media content.

fn media_retention_policy(&self) -> MediaRetentionPolicy

Get the current MediaRetentionPolicy.

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

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: 'async_trait,

Set whether the current MediaRetentionPolicy should be ignored for the media.

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

Clean up the media cache with the current MediaRetentionPolicy.

fn get_size<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<usize>, <SqliteMediaStore as MediaStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

Returns the size of the store in bytes, if known.

impl MediaStoreInner for SqliteMediaStore

type Error = Error

The error type used by this media cache store.

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

The persisted media retention policy in the media cache.

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

Persist the media retention policy in the media cache.

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<(), <SqliteMediaStore as MediaStoreInner>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: 'async_trait,

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

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<(), <SqliteMediaStore as MediaStoreInner>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: 'async_trait,

Set whether the current MediaRetentionPolicy should be ignored for the media.

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>>, <SqliteMediaStore as MediaStoreInner>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: 'async_trait,

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

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>>, <SqliteMediaStore as MediaStoreInner>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteMediaStore: 'async_trait,

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

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

Clean up the media cache with the given policy.

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

where 'life0: 'async_trait, SqliteMediaStore: 'async_trait,

The time of the last media cache cleanup.