ruma

Struct RoomId

Source
pub struct RoomId(/* private fields */);
Expand description

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§

Source§

impl RoomId

Source

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this RoomId.

Source

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

Available on crate feature events only.

Creates a byte slice from this RoomId.

Source§

impl RoomId

Source

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

Available on crate feature events only.

Try parsing a &str into an OwnedRoomId.

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

Available on crate feature events only.

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.

Source

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

Available on crate feature events only.

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

Source

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

Available on crate feature events only.

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

Source§

impl RoomId

Source

pub fn new(server_name: &ServerName) -> OwnedRoomId

Available on crate features events and 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.

Source

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

Available on crate feature events only.

Returns the server name of the room ID.

Source

pub fn matrix_to_uri(&self) -> MatrixToUri

Available on crate feature events only.

Create a matrix.to URI for this room ID.

Note that it is recommended to provide servers that should know the room to be able to find it with its room ID. For that use RoomId::matrix_to_uri_via().

§Example
use ruma_common::{room_id, server_name};

assert_eq!(
    room_id!("!somewhere:example.org").matrix_to_uri().to_string(),
    "https://matrix.to/#/!somewhere:example.org"
);
Source

pub fn matrix_to_uri_via<T>(&self, via: T) -> MatrixToUri

Available on crate feature events only.

Create a matrix.to URI for this room ID with a list of servers that should know it.

To get the list of servers, it is recommended to use the routing algorithm from the spec.

If you don’t have a list of servers, you can use RoomId::matrix_to_uri() instead.

§Example
use ruma_common::{room_id, server_name};

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

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

Available on crate feature events only.

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

Note that it is recommended to provide servers that should know the room to be able to find it with its room ID. For that use RoomId::matrix_to_event_uri_via().

Source

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

Available on crate feature events only.

Create a matrix.to URI for an event scoped under this room ID with a list of servers that should know it.

To get the list of servers, it is recommended to use the routing algorithm from the spec.

If you don’t have a list of servers, you can use RoomId::matrix_to_event_uri() instead.

Source

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

Available on crate feature events only.

Create a matrix: URI for this room ID.

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

Note that it is recommended to provide servers that should know the room to be able to find it with its room ID. For that use RoomId::matrix_uri_via().

§Example
use ruma_common::{room_id, server_name};

assert_eq!(
    room_id!("!somewhere:example.org").matrix_uri(false).to_string(),
    "matrix:roomid/somewhere:example.org"
);
Source

pub fn matrix_uri_via<T>(&self, via: T, join: bool) -> MatrixUri

Available on crate feature events only.

Create a matrix: URI for this room ID with a list of servers that should know it.

To get the list of servers, it is recommended to use the routing algorithm from the spec.

If you don’t have a list of servers, you can use RoomId::matrix_uri() instead.

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

§Example
use ruma_common::{room_id, server_name};

assert_eq!(
    room_id!("!somewhere:example.org")
        .matrix_uri_via(
            [&*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"
);
Source

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

Available on crate feature events only.

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

Note that it is recommended to provide servers that should know the room to be able to find it with its room ID. For that use RoomId::matrix_event_uri_via().

Source

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

Available on crate feature events only.

Create a matrix: URI for an event scoped under this room ID with a list of servers that should know it.

To get the list of servers, it is recommended to use the routing algorithm from the spec.

If you don’t have a list of servers, you can use RoomId::matrix_event_uri() instead.

Trait Implementations§

Source§

impl AsRef<[u8]> for RoomId

Source§

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

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

impl AsRef<RoomId> for OwnedRoomId

Source§

fn as_ref(&self) -> &RoomId

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

impl AsRef<RoomId> for RoomId

Source§

fn as_ref(&self) -> &RoomId

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

impl AsRef<str> for RoomId

Source§

fn as_ref(&self) -> &str

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

impl Borrow<RoomId> for OwnedRoomId

Source§

fn borrow(&self) -> &RoomId

Immutably borrows from an owned value. Read more
Source§

impl Clone for Box<RoomId>

Source§

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

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 RoomId

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

Source§

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

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

impl Display for RoomId

Source§

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

Formats the value using the given formatter. Read more
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<&RoomId> for Arc<RoomId>

Source§

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

Converts to this type from the input type.
Source§

impl From<&RoomId> for Box<RoomId>

Source§

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

Converts to this type from the input type.
Source§

impl From<&RoomId> for MatrixId

Source§

fn from(room_id: &RoomId) -> MatrixId

Converts to this type from the input type.
Source§

impl From<&RoomId> for OwnedRoomId

Source§

fn from(id: &RoomId) -> OwnedRoomId

Converts to this type from the input type.
Source§

impl From<&RoomId> for Rc<RoomId>

Source§

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

Converts to this type from the input type.
Source§

impl From<&RoomId> for String

Source§

fn from(id: &RoomId) -> String

Converts to this type from the input type.
Source§

impl From<OwnedRoomId> for Box<RoomId>

Source§

fn from(a: OwnedRoomId) -> Box<RoomId>

Converts to this type from the input type.
Source§

impl Hash for RoomId

Source§

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

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

impl Ord for RoomId

Source§

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

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

impl PartialEq<&RoomId> for OwnedRoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<&str> for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<Box<RoomId>> for &RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<Box<RoomId>> for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<OwnedRoomId> for &RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<OwnedRoomId> for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<RoomId> for &str

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<RoomId> for OwnedRoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<RoomId> for str

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<String> for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<str> for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq for RoomId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for RoomId

Source§

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

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

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

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

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

impl Serialize for RoomId

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 RoomId

Source§

type Owned = OwnedRoomId

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> <RoomId 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 RoomId

Source§

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 RoomId

Source§

type Error = Error

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

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

Performs the conversion.
Source§

impl TryFrom<&str> for Box<RoomId>

Source§

type Error = Error

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

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

Performs the conversion.
Source§

impl TryFrom<String> for Box<RoomId>

Source§

type Error = Error

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

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

Performs the conversion.
Source§

impl Eq for RoomId

Source§

impl StructuralPartialEq for RoomId

Auto Trait Implementations§

§

impl Freeze for RoomId

§

impl RefUnwindSafe for RoomId

§

impl Send for RoomId

§

impl !Sized for RoomId

§

impl Sync for RoomId

§

impl Unpin for RoomId

§

impl UnwindSafe for RoomId

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
Source§

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

Source§

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

Compare self to key and return their ordering.
Source§

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

Source§

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

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

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

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

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§

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