[−][src]Struct ruma::UserId
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().as_ref(), "@carl:example.com" );
Implementations
impl UserId
[src]
pub fn parse_with_server_name(
id: impl AsRef<str> + Into<Box<str, Global>>,
server_name: &ServerName
) -> Result<UserId, Error>
[src]
id: impl AsRef<str> + Into<Box<str, Global>>,
server_name: &ServerName
) -> Result<UserId, Error>
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.
impl UserId
[src]
pub fn localpart(&self) -> &str
[src]
Returns the user's localpart.
pub fn server_name(&self) -> &ServerName
[src]
Returns the server name of the user ID.
pub fn is_historical(&self) -> bool
[src]
Whether this user ID is a historical one, i.e. one that doesn't conform to the latest specification of the user ID grammar but is still accepted because it was previously allowed.
impl UserId
[src]
pub fn as_str(&self) -> &str
[src]
Creates a string slice from this UserId
pub fn as_bytes(&self) -> &[u8]ⓘ
[src]
Creates a byte slice from this UserId
Trait Implementations
impl AsRef<str> for UserId
[src]
impl Clone for UserId
[src]
impl Debug for UserId
[src]
impl<'de> Deserialize<'de> for UserId
[src]
pub fn deserialize<D>(
deserializer: D
) -> Result<UserId, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
[src]
deserializer: D
) -> Result<UserId, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
impl Display for UserId
[src]
impl Eq for UserId
[src]
impl From<UserId> for String
[src]
impl FromStr for UserId
[src]
type Err = Error
The associated error which can be returned from parsing.
pub fn from_str(s: &str) -> Result<UserId, <UserId as FromStr>::Err>
[src]
impl Hash for UserId
[src]
pub fn hash<H>(&self, state: &mut H) where
H: Hasher,
[src]
H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for UserId
[src]
pub fn cmp(&self, other: &UserId) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<'_> PartialEq<&'_ str> for UserId
[src]
pub fn eq(&self, other: &&str) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<String> for UserId
[src]
pub fn eq(&self, other: &String) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<UserId> for UserId
[src]
pub fn eq(&self, other: &UserId) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<str> for UserId
[src]
pub fn eq(&self, other: &str) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<UserId> for UserId
[src]
pub fn partial_cmp(&self, other: &UserId) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Serialize for UserId
[src]
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
[src]
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
impl<'_> TryFrom<&'_ str> for UserId
[src]
type Error = Error
The type returned in the event of a conversion error.
pub fn try_from(s: &str) -> Result<UserId, <UserId as TryFrom<&'_ str>>::Error>
[src]
impl TryFrom<String> for UserId
[src]
Auto Trait Implementations
impl RefUnwindSafe for UserId
[src]
impl Send for UserId
[src]
impl Sync for UserId
[src]
impl Unpin for UserId
[src]
impl UnwindSafe for UserId
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,