Struct ruma_identifiers::UserId

pub struct UserId {
    // some 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

fn new(server_name: &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 origin server name cannot be parsed as a valid host.

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.

fn localpart(&self) -> &str

Returns the user's localpart.

fn port(&self) -> u16

Returns the port the originating homeserver can be accessed on.

Trait Implementations

impl PartialEq for UserId

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

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

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

This method tests for !=.

impl Hash for UserId

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

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

impl Eq for UserId

impl Debug for UserId

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

Formats the value using the given formatter.

impl Display for UserId

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

Formats the value using the given formatter.

impl Serialize for UserId

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

Serializes this value into this serializer.

impl Deserialize for UserId

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

Deserialize this value given this Deserializer.

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

type Err = Error

Unstable (try_from)

The type returned in the event of a conversion error.

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

Unstable (try_from)

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.