Struct ruma_common::RoomOrAliasId

#[repr(transparent)]
pub struct RoomOrAliasId(_);

A Matrix room ID or a Matrix room alias ID.

RoomOrAliasId 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!(<&RoomOrAliasId>::try_from("#ruma:example.com").unwrap(), "#ruma:example.com");

assert_eq!(
    <&RoomOrAliasId>::try_from("!n8f893n9:example.com").unwrap(),
    "!n8f893n9:example.com"
);

Implementations

impl RoomOrAliasId

pub fn as_str(&self) -> &str

Creates a string slice from this RoomOrAliasId.

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

Creates a byte slice from this RoomOrAliasId.

impl RoomOrAliasId

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

Try parsing a &str into an OwnedRoomOrAliasId.

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

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

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

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

impl RoomOrAliasId

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

Trait Implementations

impl AsRef<RoomOrAliasId> for OwnedRoomOrAliasId

fn as_ref(&self) -> &RoomOrAliasId

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

impl AsRef<str> for RoomOrAliasId

fn as_ref(&self) -> &str

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

impl AsRef<str> for Box<RoomOrAliasId>

fn as_ref(&self) -> &str

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

impl Borrow<RoomOrAliasId> for OwnedRoomOrAliasId

fn borrow(&self) -> &RoomOrAliasId

Immutably borrows from an owned value.

impl Clone for Box<RoomOrAliasId>

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 RoomOrAliasId

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for RoomOrAliasId

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<'a> From<&'a RoomId> for &'a RoomOrAliasId

fn from(room_id: &'a RoomId) -> Self

Converts to this type from the input type.

impl From<&RoomOrAliasId> for OwnedRoomOrAliasId

fn from(id: &RoomOrAliasId) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<&RoomOrAliasId> for String

fn from(id: &RoomOrAliasId) -> Self

Converts to this type from the input type.

impl From<&RoomOrAliasId> for Box<RoomOrAliasId>

fn from(id: &RoomOrAliasId) -> Self

Converts to this type from the input type.

impl From<&RoomOrAliasId> for Rc<RoomOrAliasId>

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

Converts to this type from the input type.

impl From<&RoomOrAliasId> for Arc<RoomOrAliasId>

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

Converts to this type from the input type.

impl FromStr for Box<RoomOrAliasId>

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 RoomOrAliasId

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 RoomOrAliasId

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<&RoomOrAliasId> for OwnedRoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<&RoomOrAliasId> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialEq<&str> for RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<&str> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialEq<Box<RoomOrAliasId, Global>> for RoomOrAliasId

fn eq(&self, other: &Box<RoomOrAliasId>) -> bool

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

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

This method tests for !=.

impl PartialEq<Box<RoomOrAliasId, Global>> for &RoomOrAliasId

fn eq(&self, other: &Box<RoomOrAliasId>) -> bool

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

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

This method tests for !=.

impl PartialEq<OwnedRoomOrAliasId> for RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<OwnedRoomOrAliasId> for &RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<OwnedRoomOrAliasId> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for OwnedRoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for str

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for &str

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

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

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

This method tests for !=.

impl PartialEq<RoomOrAliasId> for String

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

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

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

This method tests for !=.

impl PartialEq<String> for RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<String> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialEq<str> for RoomOrAliasId

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

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

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

This method tests for !=.

impl PartialEq<str> for Box<RoomOrAliasId>

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

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

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

This method tests for !=.

impl PartialOrd<RoomOrAliasId> for RoomOrAliasId

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

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

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

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

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

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

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

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

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 RoomOrAliasId

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 RoomOrAliasId

type Owned = OwnedRoomOrAliasId

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 RoomId

type Error = &'a RoomAliasId

The type returned in the event of a conversion error.

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

Performs the conversion.

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 RoomOrAliasId

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

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

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 RoomOrAliasId

impl StructuralEq for RoomOrAliasId

impl StructuralPartialEq for RoomOrAliasId