Struct crackle_lib::OwnedUserId

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>

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

pub fn as_str(&self) -> &str

Creates a string slice from this UserId.

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Creates a byte slice from this UserId.

Trait Implementations

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

impl Clone for OwnedUserId

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

impl Debug for OwnedUserId

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

Formats the value using the given formatter. Read more

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

impl Display for OwnedUserId

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

Formats the value using the given formatter. Read more

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, Global>> for OwnedUserId

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

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

impl Hash for OwnedUserId

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,

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

impl Ord for OwnedUserId

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl<'_> PartialEq<&'_ UserId> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl<'_> PartialEq<&'_ str> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Box<UserId, Global>> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl<'_> PartialEq<OwnedUserId> for &'_ str

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<OwnedUserId> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<OwnedUserId> for UserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<OwnedUserId> for str

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

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

1.0.0 · source

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

This method tests for !=.

impl<'_> PartialEq<OwnedUserId> for &'_ UserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<String> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<UserId> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<str> for OwnedUserId

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

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

1.0.0 · source

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

This method tests for !=.

impl PartialOrd<OwnedUserId> for OwnedUserId

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for OwnedUserId

impl Send for OwnedUserId

impl Sync for OwnedUserId

impl Unpin for OwnedUserId

impl UnwindSafe for OwnedUserId

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

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

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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