Struct matrix_sdk_base::ruma::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",
);

Trait Implementations§

source§

impl AsRef<[u8]> for OwnedUserId

source§

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

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

impl AsRef<UserId> for OwnedUserId

source§

fn as_ref(&self) -> &UserId

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

impl AsRef<str> for OwnedUserId

source§

fn as_ref(&self) -> &str

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

impl Borrow<UserId> for OwnedUserId

source§

fn borrow(&self) -> &UserId

Immutably borrows from an owned value. Read more
source§

impl Clone for OwnedUserId

source§

fn clone(&self) -> OwnedUserId

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for OwnedUserId

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for OwnedUserId

§

type Target = UserId

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for OwnedUserId

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&OwnedUserId> for UserIdentifier

source§

fn from(id: &OwnedUserId) -> UserIdentifier

Converts to this type from the input type.
source§

impl From<&UserId> for OwnedUserId

source§

fn from(id: &UserId) -> OwnedUserId

Converts to this type from the input type.
source§

impl From<Arc<UserId>> for OwnedUserId

source§

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

Converts to this type from the input type.
source§

impl From<Box<UserId>> for OwnedUserId

source§

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

Converts to this type from the input type.
source§

impl From<OwnedUserId> for Arc<UserId>

source§

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

Converts to this type from the input type.
source§

impl From<OwnedUserId> for Box<UserId>

source§

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

Converts to this type from the input type.
source§

impl From<OwnedUserId> for MatrixId

source§

fn from(user_id: OwnedUserId) -> MatrixId

Converts to this type from the input type.
source§

impl From<OwnedUserId> for String

source§

fn from(id: OwnedUserId) -> String

Converts to this type from the input type.
source§

impl From<OwnedUserId> for UserIdentifier

source§

fn from(id: OwnedUserId) -> UserIdentifier

Converts to this type from the input type.
source§

impl FromStr for OwnedUserId

§

type Err = Error

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for OwnedUserId

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for OwnedUserId

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<&UserId> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<&str> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Arc<UserId>> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Box<UserId>> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedUserId> for &UserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedUserId> for &str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedUserId> for UserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedUserId> for str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<String> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<UserId> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<str> for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for OwnedUserId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for OwnedUserId

source§

fn partial_cmp(&self, other: &OwnedUserId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for OwnedUserId

source§

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. Read more
source§

impl TryFrom<&str> for OwnedUserId

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<String> for OwnedUserId

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl Eq for OwnedUserId

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,