Struct ruma::OwnedRoomOrAliasId

pub struct OwnedRoomOrAliasId { /* private fields */ }

Expand description

Owned variant of RoomOrAliasId

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 = RoomOrAliasId>§

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this RoomOrAliasId.

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

Available on crate feature events only.

Creates a byte slice from this RoomOrAliasId.

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

Available on crate feature events only.

Returns the server name of the room (alias) ID.

pub fn is_room_id(&self) -> bool

Available on crate feature events only.

Whether this is a room id (starts with '!')

pub fn is_room_alias_id(&self) -> bool

Available on crate feature events only.

Whether this is a room alias id (starts with '#')

Trait Implementations§

impl AsRef<[u8]> for OwnedRoomOrAliasId

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

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

impl AsRef<RoomOrAliasId> for OwnedRoomOrAliasId

fn as_ref(&self) -> &RoomOrAliasId

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

impl AsRef<str> for OwnedRoomOrAliasId

fn as_ref(&self) -> &str

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

impl Borrow<RoomOrAliasId> for OwnedRoomOrAliasId

fn borrow(&self) -> &RoomOrAliasId

Immutably borrows from an owned value. Read more

impl Clone for OwnedRoomOrAliasId

fn clone(&self) -> OwnedRoomOrAliasId

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

impl Debug for OwnedRoomOrAliasId

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

Formats the value using the given formatter. Read more

impl Deref for OwnedRoomOrAliasId

type Target = RoomOrAliasId

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedRoomOrAliasId

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for OwnedRoomOrAliasId

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

Formats the value using the given formatter. Read more

impl From<&RoomOrAliasId> for OwnedRoomOrAliasId

fn from(id: &RoomOrAliasId) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<Arc<RoomOrAliasId>> for OwnedRoomOrAliasId

fn from(a: Arc<RoomOrAliasId>) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<Box<RoomOrAliasId>> for OwnedRoomOrAliasId

fn from(b: Box<RoomOrAliasId>) -> OwnedRoomOrAliasId

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<OwnedRoomId> for OwnedRoomOrAliasId

fn from(room_id: OwnedRoomId) -> OwnedRoomOrAliasId

Converts to this type from the input type.

impl From<OwnedRoomOrAliasId> for Arc<RoomOrAliasId>

fn from(a: OwnedRoomOrAliasId) -> Arc<RoomOrAliasId>

Converts to this type from the input type.

impl From<OwnedRoomOrAliasId> for Box<RoomOrAliasId>

fn from(a: OwnedRoomOrAliasId) -> Box<RoomOrAliasId>

Converts to this type from the input type.

impl From<OwnedRoomOrAliasId> for String

fn from(id: OwnedRoomOrAliasId) -> String

Converts to this type from the input type.

impl FromStr for OwnedRoomOrAliasId

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for OwnedRoomOrAliasId

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for OwnedRoomOrAliasId

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

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

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl PartialEq<&RoomOrAliasId> for OwnedRoomOrAliasId

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

impl PartialEq<&str> for OwnedRoomOrAliasId

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.

impl PartialEq<Arc<RoomOrAliasId>> for OwnedRoomOrAliasId

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

impl PartialEq<Box<RoomOrAliasId>> for OwnedRoomOrAliasId

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

impl PartialEq<OwnedRoomOrAliasId> for &RoomOrAliasId

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

impl PartialEq<OwnedRoomOrAliasId> for &str

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

impl PartialEq<OwnedRoomOrAliasId> for Box<RoomOrAliasId>

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

impl PartialEq<OwnedRoomOrAliasId> for RoomOrAliasId

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

impl PartialEq<OwnedRoomOrAliasId> for str

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

impl PartialEq<RoomOrAliasId> for OwnedRoomOrAliasId

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

impl PartialEq<String> for OwnedRoomOrAliasId

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.

impl PartialEq<str> for OwnedRoomOrAliasId

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.

impl PartialEq for OwnedRoomOrAliasId

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

impl PartialOrd for OwnedRoomOrAliasId

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

impl Serialize for OwnedRoomOrAliasId

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

impl TryFrom<&str> for OwnedRoomOrAliasId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<OwnedRoomOrAliasId, <OwnedRoomOrAliasId as TryFrom<&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<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 OwnedRoomOrAliasId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for OwnedRoomOrAliasId

Auto Trait Implementations§

impl Freeze for OwnedRoomOrAliasId

impl RefUnwindSafe for OwnedRoomOrAliasId

impl Send for OwnedRoomOrAliasId

impl Sync for OwnedRoomOrAliasId

impl Unpin for OwnedRoomOrAliasId

impl UnwindSafe for OwnedRoomOrAliasId

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

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

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

Compare self to key and return their ordering.

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

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

Checks if this value is equivalent to the given key. Read more

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

const WITNESS: W = W::MAKE

A constant of the type witness

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

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.

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

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T