Enum ruma::api::client::uiaa::UserIdentifier

pub enum UserIdentifier {
    UserIdOrLocalpart(String),
    Email {
        address: String,
    },
    Msisdn {
        number: String,
    },
    PhoneNumber {
        country: String,
        phone: String,
    },
    // some variants omitted
}

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

Identification information for the user.

Variants

UserIdOrLocalpart(String)

Either a fully qualified Matrix user ID, or just the localpart (as part of the ‘identifier’ field).

Email

An email address.

Fields

address: String

The email address.

Msisdn

A phone number in the MSISDN format.

Fields

number: String

The phone number according to the E.164 numbering plan.

PhoneNumber

A phone number as a separate country code and phone number.

The homeserver will be responsible for canonicalizing this to the MSISDN format.

Fields

country: String

The country that the phone number is from.

This is a two-letter uppercase ISO-3166-1 alpha-2 country code.

phone: String

The phone number.

Implementations

impl UserIdentifier

pub fn third_party_id(medium: Medium, address: String) -> UserIdentifier

Creates a new UserIdentifier from the given third party identifier.

pub fn as_third_party_id(&self) -> Option<(&Medium, &str)>

Get this UserIdentifier as a third party identifier if it is one.

Trait Implementations

impl Clone for UserIdentifier

fn clone(&self) -> UserIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserIdentifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserIdentifier

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OwnedUserId> for UserIdentifier

fn from(id: &OwnedUserId) -> UserIdentifier

Converts to this type from the input type.

impl From<OwnedUserId> for UserIdentifier

fn from(id: OwnedUserId) -> UserIdentifier

Converts to this type from the input type.

impl PartialEq for UserIdentifier

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

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 UserIdentifier

impl StructuralPartialEq for UserIdentifier