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

pub enum UserIdentifier<'a> {
    UserIdOrLocalpart(&'a str),
    Email {
        address: &'a str,
    },
    Msisdn {
        number: &'a str,
    },
    PhoneNumber {
        country: &'a str,
        phone: &'a str,
    },
    // 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(&'a str)

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

Email

Fields

address: &'a str

The email address.

An email address.

Msisdn

Fields

number: &'a str

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

A phone number in the MSISDN format.

PhoneNumber

Fields

country: &'a str

The country that the phone number is from.

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

phone: &'a str

The phone number.

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

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

Implementations

impl<'a> UserIdentifier<'a>

pub fn third_party_id(medium: &'a Medium, address: &'a str) -> UserIdentifier<'a>

Creates a new UserIdentifier from the given third party identifier.

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

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

Trait Implementations

impl<'a> Clone for UserIdentifier<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UserIdentifier<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a OwnedUserId> for UserIdentifier<'a>

fn from(id: &'a OwnedUserId) -> UserIdentifier<'a>

Converts to this type from the input type.

impl<'a> From<&'a UserId> for UserIdentifier<'a>

fn from(id: &'a UserId) -> UserIdentifier<'a>

Converts to this type from the input type.

impl<'a> PartialEq<UserIdentifier<'a>> for UserIdentifier<'a>

fn eq(&self, other: &UserIdentifier<'a>) -> bool

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

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.

impl<'a> Serialize for UserIdentifier<'a>

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<'a> Eq for UserIdentifier<'a>

impl<'a> StructuralEq for UserIdentifier<'a>

impl<'a> StructuralPartialEq for UserIdentifier<'a>