Struct ruma_identifiers::RoomIdOrAliasId

pub struct RoomIdOrAliasId { /* 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.

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

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 '#')

pub fn into_either(self) -> Either<RoomId, RoomAliasId>

This is supported on feature="either" only.

Turn this RoomIdOrAliasId into Either<RoomId, RoomAliasId>

impl RoomIdOrAliasId

pub fn as_str(&self) -> &str

Creates a string slice from this RoomIdOrAliasId

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

Creates a byte slice from this RoomIdOrAliasId

Trait Implementations

impl AsRef<str> for RoomIdOrAliasId

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for RoomIdOrAliasId

fn clone(&self) -> RoomIdOrAliasId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomIdOrAliasId

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for RoomIdOrAliasId

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

Formats the value using the given formatter.

impl Eq for RoomIdOrAliasId

impl From<RoomAliasId> for RoomIdOrAliasId

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

Performs the conversion.

impl From<RoomId> for RoomIdOrAliasId

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

Performs the conversion.

impl From<RoomIdOrAliasId> for String

fn from(id: RoomIdOrAliasId) -> Self

Performs the conversion.

impl Hash for RoomIdOrAliasId

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 Ord for RoomIdOrAliasId

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<'_> PartialEq<&'_ str> for RoomIdOrAliasId

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 PartialEq<RoomIdOrAliasId> for RoomIdOrAliasId

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 PartialEq<RoomIdOrAliasId> for str

fn eq(&self, other: &RoomIdOrAliasId) -> 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<'_> PartialEq<RoomIdOrAliasId> for &'_ str

fn eq(&self, other: &RoomIdOrAliasId) -> 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 PartialEq<RoomIdOrAliasId> for String

fn eq(&self, other: &RoomIdOrAliasId) -> 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 PartialEq<String> for RoomIdOrAliasId

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 PartialEq<str> for RoomIdOrAliasId

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 PartialOrd<RoomIdOrAliasId> for RoomIdOrAliasId

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 Serialize for RoomIdOrAliasId

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

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 TryFrom<RoomIdOrAliasId> for RoomId

type Error = RoomAliasId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RoomIdOrAliasId> for RoomAliasId

type Error = RoomId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for RoomIdOrAliasId

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.