Struct MediaService 

pub struct MediaService<Time = DefaultTimeProvider>
where
    Time: TimeProvider,
{ /* private fields */ }

API for implementors of MediaStore to manage their media through their implementation of MediaStoreInner.

Implementations

impl MediaService

pub fn new() -> MediaService

Construct a new default MediaService.

MediaService::restore() should be called after constructing the MediaService to restore its previous state.

impl<Time> MediaService<Time>

where Time: TimeProvider + 'static,

pub fn restore( &self, policy: Option<MediaRetentionPolicy>, last_media_cleanup_time: Option<SystemTime>, )

Restore the previous state of the MediaRetentionPolicy from data that was persisted in the store.

This should be called immediately after constructing the MediaService.

Arguments

• policy - The MediaRetentionPolicy that was persisted in the store.

pub async fn set_media_retention_policy<Store>( &self, store: &Store, policy: MediaRetentionPolicy, ) -> Result<(), <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner + 'static,

Set the MediaRetentionPolicy of this service.

Arguments

• store - The MediaStoreInner.

• policy - The MediaRetentionPolicy to use.

pub fn media_retention_policy(&self) -> MediaRetentionPolicy

Get the MediaRetentionPolicy of this service.

pub async fn add_media_content<Store>( &self, store: &Store, request: &MediaRequestParameters, content: Vec<u8>, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Result<(), <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner + 'static,

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

Arguments

• store - The MediaStoreInner.

• request - The MediaRequestParameters of the file.

• content - The content of the file.

• ignore_policy - Whether the current MediaRetentionPolicy should be ignored.

pub async fn set_ignore_media_retention_policy<Store>( &self, store: &Store, request: &MediaRequestParameters, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Result<(), <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner,

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

The change will be taken into account in the next cleanup.

Arguments

• store - The MediaStoreInner.

• request - The MediaRequestParameters of the file.

• ignore_policy - Whether the current MediaRetentionPolicy should be ignored.

pub async fn get_media_content<Store>( &self, store: &Store, request: &MediaRequestParameters, ) -> Result<Option<Vec<u8>>, <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner + 'static,

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

Arguments

• store - The MediaStoreInner.

• request - The MediaRequestParameters of the file.

pub async fn get_media_content_for_uri<Store>( &self, store: &Store, uri: &MxcUri, ) -> Result<Option<Vec<u8>>, <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner + 'static,

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

Arguments

• store - The MediaStoreInner.

• uri - The MxcUri of the media file.

pub async fn clean<Store>( &self, store: &Store, ) -> Result<(), <Store as MediaStoreInner>::Error>

where Store: MediaStoreInner,

Clean up the media cache with the current MediaRetentionPolicy.

If there is already an ongoing cleanup, this is a noop.

Arguments

• store - The MediaStoreInner.

Trait Implementations

impl<Time> Clone for MediaService<Time>

where Time: TimeProvider,

fn clone(&self) -> MediaService<Time>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Time> Debug for MediaService<Time>

where Time: Debug + TimeProvider,

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

Formats the value using the given formatter.

impl Default for MediaService

fn default() -> MediaService

Returns the “default value” for a type.