Struct ruma_identifiers::RoomId

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

A Matrix room ID.

A RoomId is generated randomly or converted from a string slice, and can be converted back into a string as needed.

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

Implementations

impl RoomId

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

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

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>, Error>

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

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

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

impl RoomId

pub fn as_str(&self) -> &str

Creates a string slice from this RoomId.

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

Creates a byte slice from this RoomId.

impl RoomId

pub fn new(server_name: &ServerName) -> Box<Self>

Available on crate feature rand only.

Attempts to generate a RoomId for the given origin server with a localpart consisting of 18 random ASCII characters.

Fails if the given homeserver cannot be parsed as a valid host.

pub fn localpart(&self) -> &str

Returns the rooms’s unique ID.

pub fn server_name(&self) -> &ServerName

Returns the server name of the room ID.

pub fn matrix_to_uri<'a>(
    &self,
    via: impl IntoIterator<Item = &'a ServerName>
) -> MatrixToUri

Create a matrix.to URI for this room ID.

Example

use ruma_identifiers::{room_id, server_name};

assert_eq!(
    room_id!("!somewhere:example.org")
        .matrix_to_uri([&*server_name!("example.org"), &*server_name!("alt.example.org")])
        .to_string(),
    "https://matrix.to/#/%21somewhere%3Aexample.org?via=example.org&via=alt.example.org"
);

pub fn matrix_to_event_uri(&self, ev_id: &EventId) -> MatrixToUri

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

pub fn matrix_uri<'a>(
    &self,
    via: impl IntoIterator<Item = &'a ServerName>,
    join: bool
) -> MatrixUri

Create a matrix: URI for this room ID.

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

Example

use ruma_identifiers::{room_id, server_name};

assert_eq!(
    room_id!("!somewhere:example.org")
        .matrix_uri([&*server_name!("example.org"), &*server_name!("alt.example.org")], true)
        .to_string(),
    "matrix:roomid/somewhere:example.org?via=example.org&via=alt.example.org&action=join"
);

pub fn matrix_event_uri<'a>(
    &self,
    ev_id: &EventId,
    via: impl IntoIterator<Item = &'a ServerName>
) -> MatrixUri

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

Trait Implementations

impl AsRef<str> for RoomId

fn as_ref(&self) -> &str

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

impl Debug for RoomId

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

Formats the value using the given formatter.

impl Display for RoomId

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

Formats the value using the given formatter.

impl From<&'_ RoomId> for MatrixId

fn from(room_id: &RoomId) -> Self

Converts to this type from the input type.

impl From<&'_ RoomId> for Box<RoomId>

fn from(id: &RoomId) -> Self

Converts to this type from the input type.

impl From<&'_ RoomId> for Rc<RoomId>

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

Converts to this type from the input type.

impl From<&'_ RoomId> for Arc<RoomId>

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

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 Hash for RoomId

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 RoomId

fn cmp(&self, other: &RoomId) -> 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<&'_ RoomId> for Box<RoomId>

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

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<RoomId, Global>> for RoomId

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

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

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

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

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

This method tests for !=.

impl PartialEq<RoomId> for Box<RoomId>

fn eq(&self, other: &RoomId) -> 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<RoomId> for str

fn eq(&self, other: &RoomId) -> 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<RoomId> for &str

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

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

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 RoomId

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<RoomId> for RoomId

fn partial_cmp(&self, other: &RoomId) -> 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 RoomId

Available on crate feature serde only.

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 RoomId

type Owned = Box<RoomId, Global>

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)

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

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

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 Eq for RoomId

impl StructuralEq for RoomId

impl StructuralPartialEq for RoomId