Struct OwnedUserId

Source

pub struct OwnedUserId { /* private fields */ }

Expand description

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

Source

pub fn as_str(&self) -> &str

Creates a string slice from this UserId.

Source

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

Creates a byte slice from this UserId.

Source

pub fn localpart(&self) -> &str

Returns the user’s localpart.

Source

pub fn server_name(&self) -> &ServerName

Returns the server name of the user ID.

Source

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.

Source

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",
);

Source

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",
);

Struct OwnedUserIdCopy item path

Methods from Deref<Target = UserId>§

pub fn as_str(&self) -> &str

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

pub fn localpart(&self) -> &str

pub fn server_name(&self) -> &ServerName

pub fn is_historical(&self) -> bool

pub fn matrix_to_uri(&self) -> MatrixToUri

§Example

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

§Example

Trait Implementations§

impl AsRef<[u8]> for OwnedUserId

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

impl AsRef<UserId> for OwnedUserId

fn as_ref(&self) -> &UserId

impl AsRef<str> for OwnedUserId

fn as_ref(&self) -> &str

impl Borrow<UserId> for OwnedUserId

fn borrow(&self) -> &UserId

impl Clone for OwnedUserId

fn clone(&self) -> OwnedUserId

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

impl Debug for OwnedUserId

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

impl Deref for OwnedUserId

type Target = UserId

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

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

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

impl Display for OwnedUserId

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

impl From<&OwnedUserId> for OwnedDirectUserIdentifier

fn from(value: &OwnedUserId) -> OwnedDirectUserIdentifier

impl From<&OwnedUserId> for UserIdentifier

fn from(id: &OwnedUserId) -> UserIdentifier

impl From<&UserId> for OwnedUserId

fn from(id: &UserId) -> OwnedUserId

impl From<Arc<UserId>> for OwnedUserId

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

impl From<Box<UserId>> for OwnedUserId

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

impl From<OwnedUserId> for Arc<UserId>

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

impl From<OwnedUserId> for Box<UserId>

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

impl From<OwnedUserId> for MatrixId

fn from(user_id: OwnedUserId) -> MatrixId

impl From<OwnedUserId> for OwnedDirectUserIdentifier

fn from(value: OwnedUserId) -> OwnedDirectUserIdentifier

impl From<OwnedUserId> for String

fn from(id: OwnedUserId) -> String

impl From<OwnedUserId> for UserIdentifier

fn from(id: OwnedUserId) -> UserIdentifier

impl FromStr for OwnedUserId

type Err = Error

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

impl Hash for OwnedUserId

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

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

impl Ord for OwnedUserId

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

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

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

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

impl PartialEq<&DirectUserIdentifier> for OwnedUserId

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

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

impl PartialEq<&UserId> for OwnedUserId

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

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

impl PartialEq<&str> for OwnedUserId

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

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

impl PartialEq<Arc<UserId>> for OwnedUserId

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

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

impl PartialEq<Box<UserId>> for OwnedUserId

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

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

Struct OwnedUserId

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

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

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

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

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

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

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