Struct LifetimeLimits 

pub struct LifetimeLimits { /* private fields */ }

Available on crate feature api and crate feature unstable-msc1763 and (crate features client-api-c or client-api-s) and (crate features client or server) only.

Global limits for the per-room retention policy lifetimes.

Implementations

impl LifetimeLimits

pub fn new() -> LifetimeLimits

Create a new LifetimeLimits object with no limits set.

This method can be combined with the LifetimeLimits::at_least and LifetimeLimits::at_most methods to configure the individual limits.

Examples

let content = LifetimeLimits::new()
    .at_least(Duration::from_hours(24))?
    .at_most(Duration::from_hours(24 * 10))?;

pub fn from_range( lifetime_range: impl RangeBounds<Duration>, ) -> Option<LifetimeLimits>

Create a new LifetimeLimits object from a range.

Returns None if the duration of one of the limits, expressed as milliseconds, doesn’t fall into the [0, (2^53)-1] range, or if the lower bound of the range is bigger than the upper bound, i.e. 10..0.

Examples

let content =
    LifetimeLimits::from_range(Duration::from_hours(24)..Duration::from_hours(24 * 10))?;

pub fn at_most(self, max: Duration) -> Option<LifetimeLimits>

Sets the maximum value that a retention policy limit is allowed to have.

Returns None if the given limit, expressed as milliseconds, doesn’t fall into the [0, (2^53)-1] range, or if the limits don’t adhere to the max < min constraint.

pub fn at_least(self, min: Duration) -> Option<LifetimeLimits>

Sets the minimum value that a retention policy limit is allowed to have.

Returns None if the given limit, expressed as milliseconds, doesn’t fall into the [0, (2^53)-1] range, or if the limits don’t adhere to the max < min constraint.

pub fn min(&self) -> Option<Duration>

Get the minimum accepted value of this limit.

pub fn max(&self) -> Option<Duration>

Get the maximum accepted value of this limit.

Trait Implementations

impl Clone for LifetimeLimits

fn clone(&self) -> LifetimeLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LifetimeLimits

impl Debug for LifetimeLimits

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

Formats the value using the given formatter.

impl Default for LifetimeLimits

fn default() -> LifetimeLimits

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LifetimeLimits

fn deserialize<D>( deserializer: D, ) -> Result<LifetimeLimits, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LifetimeLimits

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.