Struct ruma::RoomOrAliasId

source ·
pub struct RoomOrAliasId(/* private fields */);
Expand description

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§

source§

impl RoomOrAliasId

source

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this RoomOrAliasId.

source

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

Available on crate feature events only.

Creates a byte slice from this RoomOrAliasId.

source§

impl RoomOrAliasId

source

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

Available on crate feature events only.

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.

source

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

Available on crate feature events only.

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.

source

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

Available on crate feature events only.

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

source

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

Available on crate feature events only.

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

source§

impl RoomOrAliasId

source

pub fn server_name(&self) -> Option<&ServerName>

Available on crate feature events only.

Returns the server name of the room (alias) ID.

source

pub fn is_room_id(&self) -> bool

Available on crate feature events only.

Whether this is a room id (starts with '!')

source

pub fn is_room_alias_id(&self) -> bool

Available on crate feature events only.

Whether this is a room alias id (starts with '#')

Trait Implementations§

source§

impl AsRef<[u8]> for RoomOrAliasId

source§

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

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

impl AsRef<RoomOrAliasId> for OwnedRoomOrAliasId

source§

fn as_ref(&self) -> &RoomOrAliasId

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

impl AsRef<RoomOrAliasId> for RoomOrAliasId

source§

fn as_ref(&self) -> &RoomOrAliasId

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

impl AsRef<str> for RoomOrAliasId

source§

fn as_ref(&self) -> &str

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

impl Borrow<RoomOrAliasId> for OwnedRoomOrAliasId

source§

fn borrow(&self) -> &RoomOrAliasId

Immutably borrows from an owned value. Read more
source§

impl Clone for Box<RoomOrAliasId>

source§

fn clone(&self) -> Box<RoomOrAliasId>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RoomOrAliasId

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for RoomOrAliasId

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<&RoomOrAliasId> for Arc<RoomOrAliasId>

source§

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

Converts to this type from the input type.
source§

impl From<&RoomOrAliasId> for Box<RoomOrAliasId>

source§

fn from(id: &RoomOrAliasId) -> Box<RoomOrAliasId>

Converts to this type from the input type.
source§

impl From<&RoomOrAliasId> for OwnedRoomOrAliasId

source§

fn from(id: &RoomOrAliasId) -> OwnedRoomOrAliasId

Converts to this type from the input type.
source§

impl From<&RoomOrAliasId> for Rc<RoomOrAliasId>

source§

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

Converts to this type from the input type.
source§

impl From<&RoomOrAliasId> for String

source§

fn from(id: &RoomOrAliasId) -> String

Converts to this type from the input type.
source§

impl From<OwnedRoomOrAliasId> for Box<RoomOrAliasId>

source§

fn from(a: OwnedRoomOrAliasId) -> Box<RoomOrAliasId>

Converts to this type from the input type.
source§

impl Hash for RoomOrAliasId

source§

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

Feeds this value into the given Hasher. Read more
source§

impl Ord for RoomOrAliasId

source§

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

This method returns an Ordering between self and other. Read more
source§

impl PartialEq<&RoomOrAliasId> for OwnedRoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<&str> for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Box<RoomOrAliasId>> for &RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Box<RoomOrAliasId>> for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedRoomOrAliasId> for &RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<OwnedRoomOrAliasId> for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<RoomOrAliasId> for &str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<RoomOrAliasId> for OwnedRoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<RoomOrAliasId> for str

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<String> for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<str> for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for RoomOrAliasId

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for RoomOrAliasId

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for RoomOrAliasId

source§

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. Read more
source§

impl ToOwned for RoomOrAliasId

§

type Owned = OwnedRoomOrAliasId

The resulting type after obtaining ownership.
source§

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

Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = &'a RoomId

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = &'a RoomAliasId

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<&str> for Box<RoomOrAliasId>

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from( s: &str ) -> Result<Box<RoomOrAliasId>, <Box<RoomOrAliasId> as TryFrom<&str>>::Error>

Performs the conversion.
source§

impl TryFrom<String> for Box<RoomOrAliasId>

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from( s: String ) -> Result<Box<RoomOrAliasId>, <Box<RoomOrAliasId> as TryFrom<String>>::Error>

Performs the conversion.
source§

impl Eq for RoomOrAliasId

source§

impl StructuralPartialEq for RoomOrAliasId

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more