Struct matrix_sdk::ruma::OwnedRoomId

pub struct OwnedRoomId { /* private fields */ }

Owned variant of RoomId

The wrapper type for this type is variable, by default it’ll use Box, but you can change that by setting “--cfg=ruma_identifiers_storage=...” using RUSTFLAGS or .cargo/config.toml (under [build] -> rustflags = ["..."]) to the following;

• ruma_identifiers_storage="Arc" to use Arc as a wrapper type.

Methods from Deref<Target = 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.

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

Returns the server name of the room ID.

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/#/!somewhere:example.org"
);

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

where T: IntoIterator, <T as IntoIterator>::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/#/!somewhere:example.org?via=example.org&via=alt.example.org"
);

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

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

where T: IntoIterator, <T as IntoIterator>::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.

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"
);

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

where T: IntoIterator, <T as IntoIterator>::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"
);

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

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

where T: IntoIterator, <T as IntoIterator>::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

impl AsRef<[u8]> for OwnedRoomId

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

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

impl AsRef<RoomId> for OwnedRoomId

fn as_ref(&self) -> &RoomId

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

impl AsRef<str> for OwnedRoomId

fn as_ref(&self) -> &str

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

impl Borrow<RoomId> for OwnedRoomId

fn borrow(&self) -> &RoomId

Immutably borrows from an owned value.

impl Clone for OwnedRoomId

fn clone(&self) -> OwnedRoomId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedRoomId

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

Formats the value using the given formatter.

impl Deref for OwnedRoomId

type Target = RoomId

The resulting type after dereferencing.

fn deref(&self) -> &<OwnedRoomId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedRoomId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OwnedRoomId

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

Formats the value using the given formatter.

impl From<&RoomId> for OwnedRoomId

fn from(id: &RoomId) -> OwnedRoomId

Converts to this type from the input type.

impl From<Arc<RoomId>> for OwnedRoomId

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

Converts to this type from the input type.

impl From<Box<RoomId>> for OwnedRoomId

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

Converts to this type from the input type.

impl From<OwnedRoomId> for Arc<RoomId>

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

Converts to this type from the input type.

impl From<OwnedRoomId> for Box<RoomId>

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

Converts to this type from the input type.

impl From<OwnedRoomId> for MatrixId

fn from(room_id: OwnedRoomId) -> MatrixId

Converts to this type from the input type.

impl From<OwnedRoomId> for OwnedRoomOrAliasId

fn from(room_id: OwnedRoomId) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<OwnedRoomId> for String

fn from(id: OwnedRoomId) -> String

Converts to this type from the input type.

impl FromStr for OwnedRoomId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<OwnedRoomId, <OwnedRoomId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for OwnedRoomId

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for OwnedRoomId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&RoomId> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Arc<RoomId>> for OwnedRoomId

fn eq(&self, other: &Arc<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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Box<RoomId>> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for &RoomId

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for &str

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for Box<RoomId>

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for RoomId

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for String

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedRoomId> for str

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomId> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for OwnedRoomId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for OwnedRoomId

fn eq(&self, other: &OwnedRoomId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for OwnedRoomId

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

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.

impl TryFrom<&str> for OwnedRoomId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<OwnedRoomOrAliasId> for OwnedRoomId

type Error = OwnedRoomAliasId

The type returned in the event of a conversion error.

fn try_from(id: OwnedRoomOrAliasId) -> Result<OwnedRoomId, OwnedRoomAliasId>

Performs the conversion.

impl TryFrom<String> for OwnedRoomId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for OwnedRoomId