Struct CallMemberStateKey 

pub struct CallMemberStateKey { /* private fields */ }

A type that can be used as the state_key for call member state events. Those state keys can be a combination of UserId and DeviceId.

Implementations

impl CallMemberStateKey

pub fn new( user_id: OwnedUserId, member_id: Option<String>, underscore: bool, ) -> CallMemberStateKey

Constructs a new CallMemberStateKey there are three possible formats:

• _{UserId}_{MemberId} example: _@test:user.org_DEVICE_m.call. member_id: Some(DEVICE_m.call), underscore: true
• {UserId}_{MemberId} example: @test:user.org_DEVICE_m.call. member_id: Some(DEVICE_m.call), underscore: false
• {UserId} example: @test:user.org. member_id: None, underscore is ignored: underscore: false|true

The MemberId is a combination of the UserId and the session information (session.application and session.id). The session information is an opaque string that should not be parsed after creation.

pub fn user_id(&self) -> &UserId

Returns the user id in this state key. (This is a cheap operations. The id is already type checked on initialization. And does only returns a reference to an existing OwnedUserId.)

It is recommended to not use the state key to get the user id, but rather use the sender field.

Trait Implementations

impl AsRef<str> for CallMemberStateKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CallMemberStateKey

fn clone(&self) -> CallMemberStateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallMemberStateKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallMemberStateKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CallMemberStateKeyEnum> for CallMemberStateKey

fn from(value: CallMemberStateKeyEnum) -> CallMemberStateKey

Converts to this type from the input type.

impl FromStr for CallMemberStateKey

type Err = KeyParseError

The associated error which can be returned from parsing.

fn from_str( state_key: &str, ) -> Result<CallMemberStateKey, <CallMemberStateKey as FromStr>::Err>

Parses a string s to return a value of this type.

impl Ord for CallMemberStateKey

fn cmp(&self, other: &CallMemberStateKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CallMemberStateKey

fn eq(&self, other: &CallMemberStateKey) -> 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 PartialOrd for CallMemberStateKey

fn partial_cmp(&self, other: &CallMemberStateKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CallMemberStateKey

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 Eq for CallMemberStateKey

impl StructuralPartialEq for CallMemberStateKey