Struct MediaRetentionPolicy

#[non_exhaustive]
pub struct MediaRetentionPolicy {
    pub max_cache_size: Option<usize>,
    pub max_file_size: Option<usize>,
    pub last_access_expiry: 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<usize>

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<usize>

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.

Implementations

impl MediaRetentionPolicy

pub fn new() -> MediaRetentionPolicy

Create a MediaRetentionPolicy with the default values.

pub fn empty() -> MediaRetentionPolicy

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<usize>) -> MediaRetentionPolicy

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

pub fn with_max_file_size(self, size: Option<usize>) -> MediaRetentionPolicy

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

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

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

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: usize) -> 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<usize>

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: usize) -> 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.

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 Debug for MediaRetentionPolicy

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

Formats the value using the given formatter.

impl Default for MediaRetentionPolicy

fn default() -> MediaRetentionPolicy

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<MediaRetentionPolicy, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MediaRetentionPolicy

impl Eq for MediaRetentionPolicy

impl StructuralPartialEq for MediaRetentionPolicy