Struct MediaService Copy item path

impl MediaService

pub fn new() -> Self

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,

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

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: EventCacheStoreMedia>( &self, store: &Store, policy: MediaRetentionPolicy, ) -> Result<(), Store::Error>

Set the MediaRetentionPolicy of this service.

§Arguments

store - The EventCacheStoreMedia.
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: EventCacheStoreMedia>( &self, store: &Store, request: &MediaRequestParameters, content: Vec<u8>, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Result<(), Store::Error>

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

§Arguments

store - The EventCacheStoreMedia.
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: EventCacheStoreMedia>( &self, store: &Store, request: &MediaRequestParameters, ignore_policy: IgnoreMediaRetentionPolicy, ) -> Result<(), Store::Error>

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 EventCacheStoreMedia.
request - The MediaRequestParameters of the file.
ignore_policy - Whether the current MediaRetentionPolicy should be ignored.

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

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

§Arguments

store - The EventCacheStoreMedia.
request - The MediaRequestParameters of the file.

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

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

§Arguments

store - The EventCacheStoreMedia.
uri - The MxcUri of the media file.

pub async fn clean_up_media_cache<Store: EventCacheStoreMedia>( &self, store: &Store, ) -> Result<(), Store::Error>

Clean up the media cache with the current MediaRetentionPolicy.

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

§Arguments

store - The EventCacheStoreMedia.

Trait Implementations§

impl<Time: Debug + TimeProvider> Debug for MediaService<Time>

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

Formats the value using the given formatter. Read more

impl Default for MediaService

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<Time> UnwindSafe for MediaService<Time>
where Time: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. 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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

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

Consume a handle, getting back the initial Arc<>

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

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

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

const WITNESS: W = W::MAKE

A constant of the type witness

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

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.

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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

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

impl<T> MaybeSendSync for T

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