Struct RoomAliasId 

pub struct RoomAliasId(/* private fields */);

A Matrix room alias ID.

A RoomAliasId is converted from a string slice, and can be converted back into a string as needed.

assert_eq!(<&RoomAliasId>::try_from("#ruma:example.com").unwrap(), "#ruma:example.com");

Implementations

impl RoomAliasId

pub fn as_str(&self) -> &str

Available on crate feature events only.

Extracts a string slice from this RoomAliasId.

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

Available on crate feature events only.

Extracts a byte slice from this RoomAliasId.

impl RoomAliasId

pub fn parse(s: impl AsRef<str>) -> Result<OwnedRoomAliasId, Error>

Available on crate feature events only.

Try parsing a &str into an OwnedRoomAliasId.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

impl RoomAliasId

pub fn alias(&self) -> &str

Available on crate feature events only.

Returns the room’s alias.

pub fn server_name(&self) -> &ServerName

Available on crate feature events only.

Returns the server name of the room alias ID.

pub fn matrix_to_uri(&self) -> MatrixToUri

Available on crate feature events only.

Create a matrix.to URI for this room alias ID.

pub fn matrix_to_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixToUri

👎Deprecated: Use RoomId::matrix_to_event_uri instead.

Available on crate feature events only.

Create a matrix.to URI for an event scoped under this room alias ID.

This is deprecated because room aliases are mutable, so the URI might break after a while.

pub fn matrix_uri(&self, join: bool) -> MatrixUri

Available on crate feature events only.

Create a matrix: URI for this room alias ID.

If join is true, a click on the URI should join the room.

pub fn matrix_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixUri

👎Deprecated: Use RoomId::matrix_event_uri instead.

Available on crate feature events only.

Create a matrix: URI for an event scoped under this room alias ID.

This is deprecated because room aliases are mutable, so the URI might break after a while.

Trait Implementations

impl AsRef<[u8]> for RoomAliasId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RoomAliasId> for OwnedRoomAliasId

fn as_ref(&self) -> &RoomAliasId

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RoomAliasId> for RoomAliasId

fn as_ref(&self) -> &RoomAliasId

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for RoomAliasId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RoomAliasId> for OwnedRoomAliasId

fn borrow(&self) -> &RoomAliasId

Immutably borrows from an owned value.

impl Debug for RoomAliasId

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

Formats the value using the given formatter.

impl Display for RoomAliasId

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

Formats the value using the given formatter.

impl<'a> From<&'a RoomAliasId> for &'a RoomOrAliasId

fn from(room_alias_id: &'a RoomAliasId) -> &'a RoomOrAliasId

Converts to this type from the input type.

impl From<&RoomAliasId> for MatrixId

fn from(room_alias: &RoomAliasId) -> MatrixId

Converts to this type from the input type.

impl From<&RoomAliasId> for OwnedRoomAliasId

fn from(id: &RoomAliasId) -> OwnedRoomAliasId

Converts to this type from the input type.

impl From<&RoomAliasId> for String

fn from(id: &RoomAliasId) -> String

Converts to this type from the input type.

impl Hash for RoomAliasId

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

where __H: Hasher,

Feeds this value into the given Hasher.

impl Ord for RoomAliasId

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

This method returns an Ordering between self and other.

impl PartialEq<&RoomAliasId> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<Cow<'a, str>> for RoomAliasId

fn eq(&self, other: &Cow<'a, str>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomAliasId> for &RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomAliasId> for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomAliasId> for &str

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomAliasId> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomAliasId> for str

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RoomAliasId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RoomAliasId

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.

impl ToOwned for RoomAliasId

type Owned = OwnedRoomAliasId

The resulting type after obtaining ownership.

fn to_owned(&self) -> <RoomAliasId as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

impl<'a> TryFrom<&'a RoomOrAliasId> for &'a RoomAliasId

type Error = &'a RoomId

The type returned in the event of a conversion error.

fn try_from(id: &'a RoomOrAliasId) -> Result<&'a RoomAliasId, &'a RoomId>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for RoomAliasId

impl StructuralPartialEq for RoomAliasId