Struct ruma_identifiers::UserId

pub struct UserId { /* fields omitted */ }

A Matrix user ID.

A UserId is generated randomly or converted from a string slice, and can be converted back into a string as needed.

assert_eq!(
    UserId::try_from("@carl:example.com").unwrap().to_string(),
    "@carl:example.com"
);

Methods

impl UserId

pub fn new(homeserver_host: &str) -> Result<Self, Error>

Attempts to generate a UserId for the given origin server with a localpart consisting of 12 random ASCII characters.

Fails if the given homeserver cannot be parsed as a valid host.

pub fn hostname(&self) -> &Host

Returns a Host for the user ID, containing the server name (minus the port) of the originating homeserver.

The host can be either a domain name, an IPv4 address, or an IPv6 address.

pub fn localpart(&self) -> &str

Returns the user's localpart.

pub fn port(&self) -> u16

Returns the port the originating homeserver can be accessed on.

pub fn is_historical(&self) -> bool

Whether this user ID is a historical one, i.e. one that doesn't conform to the latest specification of the user ID grammar but is still accepted because it was previously allowed.

Trait Implementations

impl Clone for UserId

fn clone(&self) -> UserId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserId

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

Deserialize this value from the given Serde deserializer.

impl Display for UserId

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl Eq for UserId

impl Hash for UserId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<UserId> for UserId

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

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

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

This method tests for !=.

impl Serialize for UserId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for UserId

impl StructuralPartialEq for UserId

impl<'a> TryFrom<&'a str> for UserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(user_id: &'a str) -> Result<Self, Error>

Attempts to create a new Matrix user ID from a string representation.

The string must include the leading @ sigil, the localpart, a literal colon, and a valid server name.