Struct OwnedRoomAliasId 

pub struct OwnedRoomAliasId { /* private fields */ }

Owned variant of RoomAliasId

Inner representation

By default, this type uses a Box<str> internally. The inner representation can be selected at compile time by using one of the following supported values:

• Arc – Use an Arc<str>.

The selected value can be set by using the ruma_identifiers_storage compile-time cfg setting. This setting can be configured using the RUSTFLAGS environment variable at build time, like this:

RUSTFLAGS="--cfg ruma_identifiers_storage=\"{value}\""

Or in .cargo/config.toml:

# General setting for all targets, overridden by per-target `rustflags` setting if set.
[build]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

# Per-target setting.
[target.<triple/cfg>]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

This setting can also be configured using the RUMA_IDENTIFIERS_STORAGE environment variable at compile time, which has the benefit of not requiring to re-compile the whole dependency chain when the value is changed, like this:

RUMA_IDENTIFIERS_STORAGE="{value}"

Methods from Deref<Target = RoomAliasId>

pub fn as_str(&self) -> &str

Extracts a string slice from this RoomAliasId.

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

Extracts a byte slice from this RoomAliasId.

pub fn alias(&self) -> &str

Returns the room’s alias.

pub fn server_name(&self) -> &ServerName

Returns the server name of the room alias ID.

pub fn matrix_to_uri(&self) -> MatrixToUri

Create a matrix.to URI for this room alias ID.

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

👎Deprecated: Use RoomId::matrix_to_event_uri instead.

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

This is deprecated because room aliases are mutable, so the URI might break after a while.

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

Create a matrix: URI for this room alias ID.

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

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

👎Deprecated: Use RoomId::matrix_event_uri instead.

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

This is deprecated because room aliases are mutable, so the URI might break after a while.

Trait Implementations

impl AsRef<[u8]> for OwnedRoomAliasId

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

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

impl AsRef<RoomAliasId> for OwnedRoomAliasId

fn as_ref(&self) -> &RoomAliasId

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

impl AsRef<str> for OwnedRoomAliasId

fn as_ref(&self) -> &str

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

impl Borrow<RoomAliasId> for OwnedRoomAliasId

fn borrow(&self) -> &RoomAliasId

Immutably borrows from an owned value.

impl Clone for OwnedRoomAliasId

fn clone(&self) -> OwnedRoomAliasId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedRoomAliasId

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

Formats the value using the given formatter.

impl Deref for OwnedRoomAliasId

type Target = RoomAliasId

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedRoomAliasId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OwnedRoomAliasId

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

Formats the value using the given formatter.

impl From<&RoomAliasId> for OwnedRoomAliasId

fn from(id: &RoomAliasId) -> OwnedRoomAliasId

Converts to this type from the input type.

impl From<OwnedRoomAliasId> for Box<str>

fn from(id: OwnedRoomAliasId) -> Box<str>

Converts to this type from the input type.

impl From<OwnedRoomAliasId> for MatrixId

fn from(room_alias: OwnedRoomAliasId) -> MatrixId

Converts to this type from the input type.

impl From<OwnedRoomAliasId> for OwnedRoomOrAliasId

fn from(room_alias_id: OwnedRoomAliasId) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<OwnedRoomAliasId> for String

fn from(id: OwnedRoomAliasId) -> String

Converts to this type from the input type.

impl FromStr for OwnedRoomAliasId

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for OwnedRoomAliasId

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 OwnedRoomAliasId

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

Restrict a value to a certain interval.

impl PartialEq<&RoomAliasId> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&str> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialEq<Cow<'a, str>> for OwnedRoomAliasId

fn eq(&self, other: &Cow<'a, str>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OwnedRoomAliasId> for &RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OwnedRoomAliasId> for &str

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OwnedRoomAliasId> for RoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OwnedRoomAliasId> for String

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OwnedRoomAliasId> for str

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<RoomAliasId> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<String> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for OwnedRoomAliasId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for OwnedRoomAliasId

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for OwnedRoomAliasId

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 OwnedRoomAliasId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Box<str>> for OwnedRoomAliasId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<Cow<'a, str>> for OwnedRoomAliasId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<OwnedRoomOrAliasId> for OwnedRoomAliasId

type Error = OwnedRoomId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for OwnedRoomAliasId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for OwnedRoomAliasId