Enum ruma::events::call::member::CallMemberEventContent

source ·
pub enum CallMemberEventContent {
    LegacyContent(LegacyMembershipContent),
    SessionContent(SessionMembershipData),
    Empty(EmptyMembershipData),
}
Available on crate features events and unstable-msc3401 only.
Expand description

The member state event for a MatrixRTC session.

This is the object containing all the data related to a Matrix users participation in a MatrixRTC session.

This is a unit struct with the enum CallMemberEventContent because a Ruma state event cannot be an enum and we need this to be an untagged enum for parsing purposes. (see CallMemberEventContent)

This struct also exposes allows to call the methods from CallMemberEventContent.

Variants§

§

LegacyContent(LegacyMembershipContent)

The legacy format for m.call.member events. (An array of memberships. The devices of one user.)

§

SessionContent(SessionMembershipData)

Normal membership events. One event per membership. Multiple state keys will be used to describe multiple devices for one user.

§

Empty(EmptyMembershipData)

An empty content means this user has been in a rtc session but is not anymore.

Implementations§

source§

impl CallMemberEventContent

source

pub fn new_legacy( memberships: Vec<LegacyMembershipData> ) -> CallMemberEventContent

source

pub fn new( application: Application, device_id: String, focus_active: ActiveFocus, foci_preferred: Vec<Focus>, created_ts: Option<MilliSecondsSinceUnixEpoch> ) -> CallMemberEventContent

source

pub fn new_empty(leave_reason: Option<LeaveReason>) -> CallMemberEventContent

Creates a new Empty CallMemberEventContent representing a left membership.

source

pub fn active_memberships( &self, origin_server_ts: Option<MilliSecondsSinceUnixEpoch> ) -> Vec<MembershipData<'_>>

All non expired memberships in this member event.

In most cases you want to use this method instead of the public memberships field. The memberships field will also include expired events.

This copies all the memberships and converts them

§Arguments
source

pub fn memberships(&self) -> Vec<MembershipData<'_>>

All the memberships for this event. Can only contain multiple elements in the case of legacy m.call.member state events.

source

pub fn set_created_ts_if_none( &mut self, origin_server_ts: MilliSecondsSinceUnixEpoch )

Set the created_ts of each MembershipData::Legacy in this event.

Each call member event contains the origin_server_ts and content.create_ts. content.create_ts is undefined for the initial event of a session (because the origin_server_ts is not known on the client). In the rust sdk we want to copy over the origin_server_ts of the event into the content. (This allows to use MinimalStateEvents and still be able to determine if a membership is expired)

Trait Implementations§

source§

impl Clone for CallMemberEventContent

source§

fn clone(&self) -> CallMemberEventContent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CallMemberEventContent

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for CallMemberEventContent

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl EventContent for CallMemberEventContent

§

type EventType = StateEventType

The Rust enum for the event kind’s known types.
source§

fn event_type(&self) -> <CallMemberEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.
source§

impl From<CallMemberEventContent> for AnyStateEventContent

source§

fn from(c: CallMemberEventContent) -> AnyStateEventContent

Converts to this type from the input type.
source§

impl PartialEq for CallMemberEventContent

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PossiblyRedactedStateEventContent for CallMemberEventContent

§

type StateKey = OwnedUserId

The type of the event’s state_key field.
source§

impl RedactContent for CallMemberEventContent

§

type Redacted = RedactedCallMemberEventContent

The redacted form of the event’s content.
source§

fn redact( self, _version: &RoomVersionId ) -> <CallMemberEventContent as RedactContent>::Redacted

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

impl Serialize for CallMemberEventContent

source§

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. Read more
source§

impl StateEventContent for CallMemberEventContent

§

type StateKey = OwnedUserId

The type of the event’s state_key field.
source§

impl StaticEventContent for CallMemberEventContent

source§

const TYPE: &'static str = "org.matrix.msc3401.call.member"

The event type.
source§

impl StaticStateEventContent for CallMemberEventContent

§

type PossiblyRedacted = CallMemberEventContent

The possibly redacted form of the event’s content.
§

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

The type of the event’s unsigned field.
source§

impl StructuralPartialEq for CallMemberEventContent

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> EventContentFromType for T

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

Constructs this event content from the given event type and JSON.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,