Struct RoomRetentionEventContent 

#[non_exhaustive]
pub struct RoomRetentionEventContent { /* private fields */ }

The content of an m.room.retention state event.

The m.room.retention state event lets room admins or moderators set or modify the history retention behaviour for a given room.

This event uses the unstable prefix defined in MSC1763.

Implementations

impl RoomRetentionEventContent

pub fn new() -> Self

Create a new RoomRetentionEventContent with no retention limits set.

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

Examples

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

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

Create a new RoomRetentionEventContent 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 = RoomRetentionEventContent::from_range(
    Duration::from_hours(24)..Duration::from_hours(24 * 10),
)?;

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

Set the maximum amount of time a message should be kept on the homeserver.

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

Set the minimum amount of time a message should be kept on the homeserver.

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 max_lifetime(&self) -> Option<Duration>

Get the maximum event lifetime defined by this state event, if any.

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

Get the minimum event lifetime defined by this state event, if any.

Trait Implementations

impl Clone for RoomRetentionEventContent

fn clone(&self) -> RoomRetentionEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomRetentionEventContent

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

Formats the value using the given formatter.

impl Default for RoomRetentionEventContent

fn default() -> RoomRetentionEventContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomRetentionEventContent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RoomRetentionEventContent> for AnyStateEventContent

Available on crate feature unstable-msc1763 only.

fn from(c: RoomRetentionEventContent) -> Self

Converts to this type from the input type.

impl From<RoomRetentionEventContent> for AnyPossiblyRedactedStateEventContent

Available on crate feature unstable-msc1763 only.

fn from(c: PossiblyRedactedRoomRetentionEventContent) -> Self

Converts to this type from the input type.

impl JsonCastable<AnyStateEventContent> for RoomRetentionEventContent

Available on crate feature unstable-msc1763 only.

impl JsonCastable<Map<String, Value>> for RoomRetentionEventContent

impl JsonCastable<RedactedRoomRetentionEventContent> for RoomRetentionEventContent

impl RedactContent for RoomRetentionEventContent

type Redacted = RedactedRoomRetentionEventContent

The redacted form of the event’s content.

fn redact(self, _rules: &RedactionRules) -> RedactedRoomRetentionEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomRetentionEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomRetentionEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

fn event_type(&self) -> StateEventType

Get the event’s type, like m.room.name.

impl StaticEventContent for RoomRetentionEventContent

const TYPE: &'static str = "org.matrix.msc1763.retention"

The statically-known part of the event type.

type IsPrefix = False

Whether the statically-known part of the event type is the prefix.

impl StaticStateEventContent for RoomRetentionEventContent

type PossiblyRedacted = RoomRetentionEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomRetentionEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.