Struct ruma_common::RoomId
source · [−]#[repr(transparent)]pub struct RoomId(_);
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
sourceimpl RoomId
impl RoomId
sourcepub fn parse(s: impl AsRef<str>) -> Result<OwnedRoomId, IdParseError>
pub fn parse(s: impl AsRef<str>) -> Result<OwnedRoomId, IdParseError>
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.
sourcepub fn parse_box(
s: impl AsRef<str> + Into<Box<str>>
) -> Result<Box<Self>, IdParseError>
pub fn parse_box(
s: impl AsRef<str> + Into<Box<str>>
) -> Result<Box<Self>, IdParseError>
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.
sourceimpl RoomId
impl RoomId
sourcepub fn new(server_name: &ServerName) -> OwnedRoomId
Available on crate feature rand
only.
pub fn new(server_name: &ServerName) -> OwnedRoomId
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.
sourcepub fn server_name(&self) -> &ServerName
pub fn server_name(&self) -> &ServerName
Returns the server name of the room ID.
sourcepub fn matrix_to_uri(&self) -> MatrixToUri
pub fn matrix_to_uri(&self) -> MatrixToUri
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/#/%21somewhere%3Aexample.org"
);
sourcepub fn matrix_to_uri_via<T>(&self, via: T) -> MatrixToUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
pub fn matrix_to_uri_via<T>(&self, via: T) -> MatrixToUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
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/#/%21somewhere%3Aexample.org?via=example.org&via=alt.example.org"
);
sourcepub fn matrix_to_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixToUri
pub fn matrix_to_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixToUri
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()
.
sourcepub fn matrix_to_event_uri_via<T>(
&self,
ev_id: impl Into<OwnedEventId>,
via: T
) -> MatrixToUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
pub fn matrix_to_event_uri_via<T>(
&self,
ev_id: impl Into<OwnedEventId>,
via: T
) -> MatrixToUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
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.
sourcepub fn matrix_uri(&self, join: bool) -> MatrixUri
pub fn matrix_uri(&self, join: bool) -> MatrixUri
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"
);
sourcepub fn matrix_uri_via<T>(&self, via: T, join: bool) -> MatrixUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
pub fn matrix_uri_via<T>(&self, via: T, join: bool) -> MatrixUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
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"
);
sourcepub fn matrix_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixUri
pub fn matrix_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixUri
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()
.
sourcepub fn matrix_event_uri_via<T>(
&self,
ev_id: impl Into<OwnedEventId>,
via: T
) -> MatrixUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
pub fn matrix_event_uri_via<T>(
&self,
ev_id: impl Into<OwnedEventId>,
via: T
) -> MatrixUriwhere
T: IntoIterator,
T::Item: Into<OwnedServerName>,
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
sourceimpl AsRef<RoomId> for OwnedRoomId
impl AsRef<RoomId> for OwnedRoomId
sourceimpl Borrow<RoomId> for OwnedRoomId
impl Borrow<RoomId> for OwnedRoomId
sourceimpl<'de> Deserialize<'de> for Box<RoomId>
impl<'de> Deserialize<'de> for Box<RoomId>
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
sourceimpl<'a> From<&'a RoomId> for &'a RoomOrAliasId
impl<'a> From<&'a RoomId> for &'a RoomOrAliasId
sourceimpl From<&RoomId> for OwnedRoomId
impl From<&RoomId> for OwnedRoomId
sourcefn from(id: &RoomId) -> OwnedRoomId
fn from(id: &RoomId) -> OwnedRoomId
sourceimpl From<OwnedRoomId> for Box<RoomId>
impl From<OwnedRoomId> for Box<RoomId>
sourcefn from(a: OwnedRoomId) -> Box<RoomId>
fn from(a: OwnedRoomId) -> Box<RoomId>
sourceimpl PartialEq<Box<RoomId, Global>> for &RoomId
impl PartialEq<Box<RoomId, Global>> for &RoomId
sourceimpl PartialEq<OwnedRoomId> for &RoomId
impl PartialEq<OwnedRoomId> for &RoomId
sourcefn eq(&self, other: &OwnedRoomId) -> bool
fn eq(&self, other: &OwnedRoomId) -> bool
sourceimpl PartialEq<OwnedRoomId> for Box<RoomId>
impl PartialEq<OwnedRoomId> for Box<RoomId>
sourcefn eq(&self, other: &OwnedRoomId) -> bool
fn eq(&self, other: &OwnedRoomId) -> bool
sourceimpl PartialEq<OwnedRoomId> for RoomId
impl PartialEq<OwnedRoomId> for RoomId
sourcefn eq(&self, other: &OwnedRoomId) -> bool
fn eq(&self, other: &OwnedRoomId) -> bool
sourceimpl PartialOrd<RoomId> for RoomId
impl PartialOrd<RoomId> for RoomId
sourcefn partial_cmp(&self, other: &RoomId) -> Option<Ordering>
fn partial_cmp(&self, other: &RoomId) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl ToOwned for RoomId
impl ToOwned for RoomId
type Owned = OwnedRoomId
type Owned = OwnedRoomId
sourcefn to_owned(&self) -> Self::Owned
fn to_owned(&self) -> Self::Owned
1.63.0 · sourcefn clone_into(&self, target: &mut Self::Owned)
fn clone_into(&self, target: &mut Self::Owned)
sourceimpl<'a> TryFrom<&'a RoomOrAliasId> for &'a RoomId
impl<'a> TryFrom<&'a RoomOrAliasId> for &'a RoomId
type Error = &'a RoomAliasId
type Error = &'a RoomAliasId
sourcefn try_from(id: &'a RoomOrAliasId) -> Result<&'a RoomId, &'a RoomAliasId>
fn try_from(id: &'a RoomOrAliasId) -> Result<&'a RoomId, &'a RoomAliasId>
impl Eq for RoomId
impl StructuralEq for RoomId
impl StructuralPartialEq for RoomId
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.