Enum ruma_identifiers::RoomIdOrAliasId

pub enum RoomIdOrAliasId {
    RoomAliasId(RoomAliasId),
    RoomId(RoomId),
}

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().to_string(),
    "#ruma:example.com"
);

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

Variants

RoomAliasId(RoomAliasId)

A Matrix room alias ID.

RoomId(RoomId)

A Matrix room ID.

Trait Implementations

impl Eq for RoomIdOrAliasId

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

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

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

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

This method tests for !=.

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

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

Formats the value using the given formatter.

impl Display for RoomIdOrAliasId

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

Formats the value using the given formatter.

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

type Error = Error

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

The type returned in the event of a conversion error.

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

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

Attempts to create a new Matrix room ID or a room alias ID from a string representation.

The string must either include the leading ! sigil, the opaque ID, a literal colon, and a valid server name or include the leading # sigil, the alias, a literal colon, and a valid server name.

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