Struct ruma_identifiers::room_id_or_room_alias_id::RoomIdOrAliasId

pub struct RoomIdOrAliasId<T> { /* fields omitted */ }

A Matrix room ID or a Matrix room alias ID.

RoomIdOrAliasId is useful for APIs that accept either kind of room identifier. It is converted from a string slice, and can be converted back into a string as needed. When converted from a string slice, the variant is determined by the leading sigil character.

It is discouraged to use this type directly – instead use one of the aliases (RoomIdOrRoomAliasId and RoomIdOrRoomAliasIdRef) in the crate root.

assert_eq!(
    RoomIdOrAliasId::try_from("#ruma:example.com").unwrap().as_ref(),
    "#ruma:example.com"
);

assert_eq!(
    RoomIdOrAliasId::try_from("!n8f893n9:example.com").unwrap().as_ref(),
    "!n8f893n9:example.com"
);

Implementations

impl<T> RoomIdOrAliasId<T> where
    T: AsRef<str>, 

pub fn as_ref(&self) -> RoomIdOrAliasId<&str>

Creates a reference to this RoomIdOrAliasId.

pub fn localpart(&self) -> &str

Returns the local part (everything after the ! or # and before the first colon).

pub fn server_name(&self) -> ServerName<&str>

Returns the server name of the room (alias) ID.

pub fn is_room_id(&self) -> bool

Whether this is a room id (starts with '!')

pub fn is_room_alias_id(&self) -> bool

Whether this is a room alias id (starts with '#')

impl<T: AsRef<str>> RoomIdOrAliasId<T>

pub fn as_str(&self) -> &str

Creates a string slice from this RoomIdOrAliasId

Trait Implementations

impl<T: AsRef<str>> AsRef<str> for RoomIdOrAliasId<T>

fn as_ref(&self) -> &str

Performs the conversion.

impl<T: Clone> Clone for RoomIdOrAliasId<T>

fn clone(&self) -> RoomIdOrAliasId<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for RoomIdOrAliasId<T>

impl<T: Debug> Debug for RoomIdOrAliasId<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomIdOrAliasId<Box<str>>

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

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for RoomIdOrAliasId<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Eq> Eq for RoomIdOrAliasId<T>

impl<'a> From<&'a RoomIdOrAliasId<Box<str>>> for RoomIdOrAliasId<&'a str>

fn from(id: &'a RoomIdOrAliasId<Box<str>>) -> Self

Performs the conversion.

impl<T> From<RoomAliasId<T>> for RoomIdOrAliasId<T>

fn from(
    RoomAliasId { full_id: full_id, colon_idx: colon_idx }: RoomAliasId<T>
) -> Self

Performs the conversion.

impl<T> From<RoomId<T>> for RoomIdOrAliasId<T>

fn from(RoomId { full_id: full_id, colon_idx: colon_idx }: RoomId<T>) -> Self

Performs the conversion.

impl From<RoomIdOrAliasId<Box<str>>> for String

fn from(id: RoomIdOrAliasId<Box<str>>) -> Self

Performs the conversion.

impl<T: Hash> Hash for RoomIdOrAliasId<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for RoomIdOrAliasId<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'_, T: AsRef<str>> PartialEq<&'_ str> for RoomIdOrAliasId<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialEq> PartialEq<RoomIdOrAliasId<T>> for RoomIdOrAliasId<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, T: AsRef<str>> PartialEq<RoomIdOrAliasId<T>> for &'_ str

fn eq(&self, other: &RoomIdOrAliasId<T>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: AsRef<str>> PartialEq<RoomIdOrAliasId<T>> for String

fn eq(&self, other: &RoomIdOrAliasId<T>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: AsRef<str>> PartialEq<String> for RoomIdOrAliasId<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<RoomIdOrAliasId<T>> for RoomIdOrAliasId<T>

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

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: AsRef<str>> Serialize for RoomIdOrAliasId<T>

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

Serialize this value into the given Serde serializer.

impl<'_> TryFrom<&'_ str> for RoomIdOrAliasId<Box<str>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for RoomIdOrAliasId<&'a str>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: AsRef<str>> TryFrom<RoomIdOrAliasId<T>> for RoomId<T>

type Error = RoomAliasId<T>

The type returned in the event of a conversion error.

fn try_from(id: RoomIdOrAliasId<T>) -> Result<RoomId<T>, RoomAliasId<T>>

Performs the conversion.

impl<T: AsRef<str>> TryFrom<RoomIdOrAliasId<T>> for RoomAliasId<T>

type Error = RoomId<T>

The type returned in the event of a conversion error.

fn try_from(id: RoomIdOrAliasId<T>) -> Result<RoomAliasId<T>, RoomId<T>>

Performs the conversion.

impl TryFrom<String> for RoomIdOrAliasId<Box<str>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.