Struct ruma_common::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

Creates a string slice from this RoomAliasId.

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

Creates a byte slice from this RoomAliasId.

impl RoomAliasId

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

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.

pub fn parse_box( s: impl AsRef<str> + Into<Box<str>>, ) -> Result<Box<Self>, IdParseError>

Try parsing a &str into a Box<RoomAliasId>.

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

pub fn parse_rc( s: impl AsRef<str> + Into<Rc<str>>, ) -> Result<Rc<Self>, IdParseError>

Try parsing a &str into an Rc<RoomAliasId>.

pub fn parse_arc( s: impl AsRef<str> + Into<Arc<str>>, ) -> Result<Arc<Self>, IdParseError>

Try parsing a &str into an Arc<RoomAliasId>.

impl RoomAliasId

pub fn alias(&self) -> &str

Returns the room’s alias.

pub fn server_name(&self) -> &ServerName

Returns the server name of the room alias ID.

pub fn matrix_to_uri(&self) -> MatrixToUri

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.

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

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.

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

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

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

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

fn as_ref(&self) -> &str

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 Clone for Box<RoomAliasId>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomAliasId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Box<RoomAliasId>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RoomAliasId

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<&RoomAliasId> for Arc<RoomAliasId>

fn from(s: &RoomAliasId) -> Arc<RoomAliasId>

Converts to this type from the input type.

impl From<&RoomAliasId> for Box<RoomAliasId>

fn from(id: &RoomAliasId) -> Self

Converts to this type from the input type.

impl From<&RoomAliasId> for MatrixId

fn from(room_alias: &RoomAliasId) -> Self

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

fn from(s: &RoomAliasId) -> Rc<RoomAliasId>

Converts to this type from the input type.

impl From<&RoomAliasId> for String

fn from(id: &RoomAliasId) -> Self

Converts to this type from the input type.

impl From<OwnedRoomAliasId> for Box<RoomAliasId>

fn from(a: OwnedRoomAliasId) -> Box<RoomAliasId>

Converts to this type from the input type.

impl FromStr for Box<RoomAliasId>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RoomAliasId

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

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 Box<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 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 Box<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<&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<Box<RoomAliasId>> for &RoomAliasId

fn eq(&self, other: &Box<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<Box<RoomAliasId>> for RoomAliasId

fn eq(&self, other: &Box<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<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 Box<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 Box<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 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 String

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 Box<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<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 Box<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<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::Ok, S::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) -> Self::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<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Box<RoomAliasId>

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<String> for Box<RoomAliasId>

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.

impl Eq for RoomAliasId

impl StructuralPartialEq for RoomAliasId