Enum ruma_events::call::member::MembershipData

#[non_exhaustive]
pub enum MembershipData<'a> {
    Legacy(&'a LegacyMembershipData),
    Session(&'a SessionMembershipData),
}

The data object that contains the information for one membership.

It can be a legacy or a normal MatrixRTC Session membership.

The legacy format contains time information to compute if it is expired or not. SessionMembershipData does not have the concept of timestamp based expiration anymore. The state event will reliably be set to empty when the user disconnects.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Legacy(&'a LegacyMembershipData)

The legacy format (using an array of memberships for each device -> one event per user)

Session(&'a SessionMembershipData)

One event per device. SessionMembershipData contains all the information required to represent the current membership state of one device.

Implementations

impl<'a> MembershipData<'a>

pub fn application(&self) -> &Application

The application this RTC membership participates in (the session type, can be m.call…)

pub fn device_id(&self) -> &DeviceId

The device id of this membership.

pub fn focus_active(&self) -> &ActiveFocus

The active focus is a FocusType specific object that describes how this user is currently connected.

It can use the foci_preferred list to choose one of the available (preferred) foci or specific information on how to connect to this user.

Every user needs to converge to use the same focus_active type.

pub fn foci_preferred(&self) -> &Vec<Focus>

The list of available/preferred options this user provides to connect to the call.

pub fn is_room_call(&self) -> bool

The application of the membership is “m.call” and the scope is “m.room”.

pub fn is_call(&self) -> bool

The application of the membership is “m.call”.

pub fn is_expired( &self, origin_server_ts: Option<MilliSecondsSinceUnixEpoch>, ) -> bool

Checks if the event is expired. This is only relevant for LegacyMembershipData returns false if its SessionMembershipData

pub fn created_ts(&self) -> Option<MilliSecondsSinceUnixEpoch>

Gets the created_ts of the event.

This is the origin_server_ts for session data. For legacy events this can either be the origin server ts or a copy from the origin_server_ts since we expect legacy events to get updated (when a new device joins/leaves).

Trait Implementations

impl<'a> Clone for MembershipData<'a>

fn clone(&self) -> MembershipData<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MembershipData<'a>

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

Formats the value using the given formatter.