Struct UserId

pub struct UserId(/* private fields */);

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(), "@carl:example.com");

Implementations

impl UserId

pub fn as_str(&self) -> &str

Creates a string slice from this UserId.

pub fn as_bytes(&self) -> &[u8]

Creates a byte slice from this UserId.

impl UserId

pub fn parse(s: impl AsRef<str>) -> Result<OwnedUserId, IdParseError>

Try parsing a &str into an OwnedUserId.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_box( s: impl AsRef<str> + Into<Box<str>>, ) -> Result<Box<Self>, IdParseError>

Try parsing a &str into a Box<UserId>.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_rc( s: impl AsRef<str> + Into<Rc<str>>, ) -> Result<Rc<Self>, IdParseError>

Try parsing a &str into an Rc<UserId>.

pub fn parse_arc( s: impl AsRef<str> + Into<Arc<str>>, ) -> Result<Arc<Self>, IdParseError>

Try parsing a &str into an Arc<UserId>.

impl UserId

pub fn new(server_name: &ServerName) -> OwnedUserId

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

pub fn parse_with_server_name( id: impl AsRef<str> + Into<Box<str>>, server_name: &ServerName, ) -> Result<OwnedUserId, IdParseError>

Attempts to complete a user ID, by adding the colon + server name and @ prefix, if not present already.

This is a convenience function for the login API, where a user can supply either their full user ID or just the localpart. It only supports a valid user ID or a valid user ID localpart, not the localpart plus the @ prefix, or the localpart plus server name without the @ prefix.

pub fn parse_with_server_name_rc( id: impl AsRef<str> + Into<Rc<str>>, server_name: &ServerName, ) -> Result<Rc<Self>, IdParseError>

Variation of parse_with_server_name that returns Rc<Self>.

pub fn parse_with_server_name_arc( id: impl AsRef<str> + Into<Arc<str>>, server_name: &ServerName, ) -> Result<Arc<Self>, IdParseError>

Variation of parse_with_server_name that returns Arc<Self>.

pub fn localpart(&self) -> &str

Returns the user’s localpart.

pub fn server_name(&self) -> &ServerName

Returns the server name of the user ID.

pub fn is_historical(&self) -> bool

Whether this user ID is a historical one.

A historical user ID is one that doesn’t conform to the latest specification of the user ID grammar but is still accepted because it was previously allowed.

pub fn matrix_to_uri(&self) -> MatrixToUri

Create a matrix.to URI for this user ID.

Example

use ruma_common::user_id;

let message = format!(
    r#"Thanks for the update <a href="{link}">{display_name}</a>."#,
    link = user_id!("@jplatte:notareal.hs").matrix_to_uri(),
    display_name = "jplatte",
);

pub fn matrix_uri(&self, chat: bool) -> MatrixUri

Create a matrix: URI for this user ID.

If chat is true, a click on the URI should start a direct message with the user.

Example

use ruma_common::user_id;

let message = format!(
    r#"Thanks for the update <a href="{link}">{display_name}</a>."#,
    link = user_id!("@jplatte:notareal.hs").matrix_uri(false),
    display_name = "jplatte",
);

Trait Implementations

impl AsRef<[u8]> for Box<UserId>

fn as_ref(&self) -> &[u8]

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

impl AsRef<[u8]> for UserId

fn as_ref(&self) -> &[u8]

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

impl AsRef<UserId> for OwnedUserId

fn as_ref(&self) -> &UserId

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

impl AsRef<UserId> for UserId

fn as_ref(&self) -> &UserId

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

impl AsRef<str> for Box<UserId>

fn as_ref(&self) -> &str

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

impl AsRef<str> for UserId

fn as_ref(&self) -> &str

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

impl Borrow<UserId> for OwnedUserId

fn borrow(&self) -> &UserId

Immutably borrows from an owned value.

impl Clone for Box<UserId>

fn clone(&self) -> Self

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 Box<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<'_>) -> Result

Formats the value using the given formatter.

impl From<&UserId> for Arc<UserId>

fn from(s: &UserId) -> Arc<UserId>

Converts to this type from the input type.

impl From<&UserId> for Box<UserId>

fn from(id: &UserId) -> Self

Converts to this type from the input type.

impl From<&UserId> for MatrixId

fn from(user_id: &UserId) -> Self

Converts to this type from the input type.

impl From<&UserId> for OwnedUserId

fn from(id: &UserId) -> OwnedUserId

Converts to this type from the input type.

impl From<&UserId> for Rc<UserId>

fn from(s: &UserId) -> Rc<UserId>

Converts to this type from the input type.

impl From<&UserId> for String

fn from(id: &UserId) -> Self

Converts to this type from the input type.

impl From<OwnedUserId> for Box<UserId>

fn from(a: OwnedUserId) -> Box<UserId>

Converts to this type from the input type.

impl FromStr for Box<UserId>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for UserId

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

Feeds this value into the given Hasher.

impl Ord for UserId

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

This method returns an Ordering between self and other.

impl PartialEq<&UserId> for Box<UserId>

fn eq(&self, other: &&UserId) -> 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 PartialEq<&UserId> for OwnedUserId

fn eq(&self, other: &&UserId) -> 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 PartialEq<&str> for Box<UserId>

fn eq(&self, other: &&str) -> 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 PartialEq<&str> for UserId

fn eq(&self, other: &&str) -> 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 PartialEq<Box<UserId>> for &UserId

fn eq(&self, other: &Box<UserId>) -> 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 PartialEq<Box<UserId>> for UserId

fn eq(&self, other: &Box<UserId>) -> 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 PartialEq<OwnedUserId> for &UserId

fn eq(&self, other: &OwnedUserId) -> 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 PartialEq<OwnedUserId> for Box<UserId>

fn eq(&self, other: &OwnedUserId) -> 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 PartialEq<OwnedUserId> for UserId

fn eq(&self, other: &OwnedUserId) -> 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 PartialEq<String> for Box<UserId>

fn eq(&self, other: &String) -> 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 PartialEq<String> for UserId

fn eq(&self, other: &String) -> 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 PartialEq<UserId> for &str

fn eq(&self, other: &UserId) -> 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 PartialEq<UserId> for Box<UserId>

fn eq(&self, other: &UserId) -> 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 PartialEq<UserId> for OwnedUserId

fn eq(&self, other: &UserId) -> 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 PartialEq<UserId> for String

fn eq(&self, other: &UserId) -> 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 PartialEq<UserId> for str

fn eq(&self, other: &UserId) -> 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 PartialEq<str> for Box<UserId>

fn eq(&self, other: &str) -> 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 PartialEq<str> for UserId

fn eq(&self, other: &str) -> 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 PartialEq for UserId

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

fn partial_cmp(&self, other: &UserId) -> 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 UserId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToOwned for UserId

type Owned = OwnedUserId

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Box<UserId>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Box<UserId>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for UserId

impl StructuralPartialEq for UserId