Struct MediaRetentionPolicy

#[non_exhaustive]
pub struct MediaRetentionPolicy {
    pub max_cache_size: Option<u64>,
    pub max_file_size: Option<u64>,
    pub last_access_expiry: Option<Duration>,
    pub cleanup_frequency: Option<Duration>,
}

The retention policy for media content used by the EventCacheStore.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_cache_size: Option<u64>

The maximum authorized size of the overall media cache, in bytes.

The cache size is defined as the sum of the sizes of all the (possibly encrypted) media contents in the cache, excluding any metadata associated with them.

If this is set and the cache size is bigger than this value, the oldest media contents in the cache will be removed during a cleanup until the cache size is below this threshold.

Note that it is possible for the cache size to temporarily exceed this value between two cleanups.

Defaults to 400 MiB.

max_file_size: Option<u64>

The maximum authorized size of a single media content, in bytes.

The size of a media content is the size taken by the content in the database, after it was possibly encrypted, so it might differ from the initial size of the content.

The maximum authorized size of a single media content is actually the lowest value between max_cache_size and max_file_size.

If it is set, media content bigger than the maximum size will not be cached. If the maximum size changed after media content that exceeds the new value was cached, the corresponding content will be removed during a cleanup.

Defaults to 20 MiB.

last_access_expiry: Option<Duration>

The duration after which unaccessed media content is considered expired.

If this is set, media content whose last access is older than this duration will be removed from the media cache during a cleanup.

Defaults to 60 days.

cleanup_frequency: Option<Duration>

The duration between two automatic media cache cleanups.

If this is set, a cleanup will be triggered after the given duration is elapsed, at the next call to the media cache API. If this is set to zero, each call to the media cache API will trigger a cleanup. If this is None, cleanups will only occur if they are triggered manually.

Defaults to running cleanups daily.

Implementations

impl MediaRetentionPolicy

pub fn new() -> Self

Create a MediaRetentionPolicy with the default values.

pub fn empty() -> Self

Create an empty MediaRetentionPolicy.

This means that all media will be cached and cleanups have no effect.

pub fn with_max_cache_size(self, size: Option<u64>) -> Self

Set the maximum authorized size of the overall media cache, in bytes.

pub fn with_max_file_size(self, size: Option<u64>) -> Self

Set the maximum authorized size of a single media content, in bytes.

pub fn with_last_access_expiry(self, duration: Option<Duration>) -> Self

Set the duration before which unaccessed media content is considered expired.

pub fn with_cleanup_frequency(self, duration: Option<Duration>) -> Self

Set the duration between two automatic media cache cleanups.

pub fn has_limitations(&self) -> bool

Whether this policy has limitations.

If this policy has no limitations, a cleanup job would have no effect.

Returns true if at least one limitation is set.

pub fn exceeds_max_cache_size(&self, size: u64) -> bool

Whether the given size exceeds the maximum authorized size of the media cache.

Arguments

• size - The overall size of the media cache to check, in bytes.

pub fn computed_max_file_size(&self) -> Option<u64>

The computed maximum authorized size of a single media content, in bytes.

This is the lowest value between max_cache_size and max_file_size.

pub fn exceeds_max_file_size(&self, size: u64) -> bool

Whether the given size, in bytes, exceeds the computed maximum authorized size of a single media content.

Arguments

• size - The size of the media content to check, in bytes.

pub fn has_content_expired( &self, current_time: SystemTime, last_access_time: SystemTime, ) -> bool

Whether a content whose last access was at the given time has expired.

Arguments

• current_time - The current time.

• last_access_time - The time when the media content to check was last accessed.

pub fn should_clean_up( &self, current_time: SystemTime, last_cleanup_time: SystemTime, ) -> bool

Whether an automatic media cache cleanup should be triggered given the time of the last cleanup.

Arguments

• current_time - The current time.

• last_cleanup_time - The time of the last media cache cleanup.

Trait Implementations

impl Clone for MediaRetentionPolicy

fn clone(&self) -> MediaRetentionPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for MediaRetentionPolicy

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for MediaRetentionPolicy

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

Formats the value using the given formatter.

impl Default for MediaRetentionPolicy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MediaRetentionPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for MediaRetentionPolicy

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for MediaRetentionPolicy

type FfiType = <MediaRetentionPolicy as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for MediaRetentionPolicy

type LiftType = MediaRetentionPolicy

impl<UT> LiftReturn<UT> for MediaRetentionPolicy

type ReturnType = <MediaRetentionPolicy as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for MediaRetentionPolicy

type FfiType = <MediaRetentionPolicy as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for MediaRetentionPolicy

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for MediaRetentionPolicy

type ReturnType = <MediaRetentionPolicy as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl PartialEq for MediaRetentionPolicy

fn eq(&self, other: &MediaRetentionPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MediaRetentionPolicy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for MediaRetentionPolicy

const TYPE_ID_META: MetadataBuffer

impl Copy for MediaRetentionPolicy

impl Eq for MediaRetentionPolicy

impl StructuralPartialEq for MediaRetentionPolicy