Struct OwnedUserId

pub struct OwnedUserId { /* private fields */ }

Owned variant of UserId

The wrapper type for this type is variable, by default it’ll use Box, but you can change that by setting “--cfg=ruma_identifiers_storage=...” using RUSTFLAGS or .cargo/config.toml (under [build] -> rustflags = ["..."]) to the following;

• ruma_identifiers_storage="Arc" to use Arc as a wrapper type.

Methods from Deref<Target = UserId>

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this UserId.

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

Available on crate feature events only.

Creates a byte slice from this UserId.

pub fn localpart(&self) -> &str

Available on crate feature events only.

Returns the user’s localpart.

pub fn server_name(&self) -> &ServerName

Available on crate feature events only.

Returns the server name of the user ID.

pub fn is_historical(&self) -> bool

Available on crate feature events only.

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

Available on crate feature events only.

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

Available on crate feature events only.

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 OwnedUserId

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<str> for OwnedUserId

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 OwnedUserId

fn clone(&self) -> OwnedUserId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedUserId

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

Formats the value using the given formatter.

impl Deref for OwnedUserId

type Target = UserId

The resulting type after dereferencing.

fn deref(&self) -> &<OwnedUserId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedUserId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OwnedUserId

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

Formats the value using the given formatter.

impl From<&OwnedUserId> for OwnedDirectUserIdentifier

fn from(value: &OwnedUserId) -> OwnedDirectUserIdentifier

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 From<&UserId> for OwnedUserId

fn from(id: &UserId) -> OwnedUserId

Converts to this type from the input type.

impl From<Arc<UserId>> for OwnedUserId

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

Converts to this type from the input type.

impl From<Box<UserId>> for OwnedUserId

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

Converts to this type from the input type.

impl From<OwnedUserId> for Arc<UserId>

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

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 From<OwnedUserId> for MatrixId

fn from(user_id: OwnedUserId) -> MatrixId

Converts to this type from the input type.

impl From<OwnedUserId> for OwnedDirectUserIdentifier

fn from(value: OwnedUserId) -> OwnedDirectUserIdentifier

Converts to this type from the input type.

impl From<OwnedUserId> for String

fn from(id: OwnedUserId) -> String

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 FromStr for OwnedUserId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<OwnedUserId, <OwnedUserId as FromStr>::Err>

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

impl Hash for OwnedUserId

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for OwnedUserId

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&DirectUserIdentifier> for OwnedUserId

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

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<Arc<UserId>> for OwnedUserId

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

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<OwnedDirectUserIdentifier> for OwnedUserId

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

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<OwnedUserId> for &str

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 OwnedDirectUserIdentifier

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<OwnedUserId> for str

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 OwnedUserId

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 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 OwnedUserId

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 OwnedUserId

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 PartialOrd for OwnedUserId

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

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 TryFrom<&DirectUserIdentifier> for OwnedUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: &DirectUserIdentifier, ) -> Result<OwnedUserId, <OwnedUserId as TryFrom<&DirectUserIdentifier>>::Error>

Performs the conversion.

impl TryFrom<&OwnedDirectUserIdentifier> for OwnedUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: &OwnedDirectUserIdentifier, ) -> Result<OwnedUserId, <OwnedUserId as TryFrom<&OwnedDirectUserIdentifier>>::Error>

Performs the conversion.

impl TryFrom<&str> for OwnedUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<OwnedUserId, <OwnedUserId as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<OwnedDirectUserIdentifier> for OwnedUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: OwnedDirectUserIdentifier, ) -> Result<OwnedUserId, <OwnedUserId as TryFrom<OwnedDirectUserIdentifier>>::Error>

Performs the conversion.

impl TryFrom<String> for OwnedUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<OwnedUserId, <OwnedUserId as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for OwnedUserId