Struct crackle_lib::OwnedRoomId

pub struct OwnedRoomId { /* private fields */ }

Expand description

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 localpart(&self) -> &str

Returns the rooms’s unique ID.

pub fn server_name(&self) -> &ServerName

Returns the server name of the room ID.

pub fn matrix_to_uri<'a>(
&self,
via: impl IntoIterator<Item = &'a ServerName>
) -> MatrixToUri

Create a matrix.to URI for this room ID.

Example

use ruma_common::{room_id, server_name};

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

pub fn matrix_to_event_uri(&self, ev_id: &EventId) -> MatrixToUri

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

pub fn matrix_uri<'a>(
    &self,
    via: impl IntoIterator<Item = &'a ServerName>,
    join: bool
) -> MatrixUri

Create a matrix: URI for this room ID.

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([&*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<'a>(
    &self,
    ev_id: &EventId,
    via: impl IntoIterator<Item = &'a ServerName>
) -> MatrixUri

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

pub fn as_str(&self) -> &str

Creates a string slice from this RoomId.

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Creates a byte slice from this RoomId.

Trait Implementations

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. Read more

impl Clone for OwnedRoomId

fn clone(&self) -> OwnedRoomId

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 OwnedRoomId

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

Formats the value using the given formatter. Read more

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. Read more

impl Display for OwnedRoomId

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

Formats the value using the given formatter. Read more

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, Global>> for OwnedRoomId

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

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. Read more

impl Hash for OwnedRoomId

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,

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

impl Ord for OwnedRoomId

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

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

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Box<RoomId, Global>> for OwnedRoomId

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<OwnedRoomId> for OwnedRoomId

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialOrd<OwnedRoomId> for OwnedRoomId

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

This method 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

This method 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

This method 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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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. Read more

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

Auto Trait Implementations

impl RefUnwindSafe for OwnedRoomId

impl Send for OwnedRoomId

impl Sync for OwnedRoomId

impl Unpin for OwnedRoomId

impl UnwindSafe for OwnedRoomId

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. 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

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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

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

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.

const: unstable · source

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.

const: unstable · source

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