Struct ruma_common::DeviceId

source ·
pub struct DeviceId(/* private fields */);
Expand description

A Matrix key ID.

Device identifiers in Matrix are completely opaque character sequences. This type is provided simply for its semantic value.

§Example

use ruma_common::{device_id, DeviceId, OwnedDeviceId};

let random_id = DeviceId::new();
assert_eq!(random_id.as_str().len(), 8);

let static_id = device_id!("01234567");
assert_eq!(static_id.as_str(), "01234567");

let ref_id: &DeviceId = "abcdefghi".into();
assert_eq!(ref_id.as_str(), "abcdefghi");

let owned_id: OwnedDeviceId = "ijklmnop".into();
assert_eq!(owned_id.as_str(), "ijklmnop");

Implementations§

source§

impl DeviceId

source

pub fn as_str(&self) -> &str

Creates a string slice from this DeviceId.

source

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

Creates a byte slice from this DeviceId.

source§

impl DeviceId

source

pub fn new() -> OwnedDeviceId

Available on crate feature rand only.

Generates a random DeviceId, suitable for assignment to a new device.

Trait Implementations§

source§

impl AsRef<[u8]> for Box<DeviceId>

source§

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

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

impl AsRef<[u8]> for DeviceId

source§

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

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

impl AsRef<DeviceId> for DeviceId

source§

fn as_ref(&self) -> &DeviceId

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

impl AsRef<DeviceId> for OwnedDeviceId

source§

fn as_ref(&self) -> &DeviceId

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

impl AsRef<str> for Box<DeviceId>

source§

fn as_ref(&self) -> &str

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

impl AsRef<str> for DeviceId

source§

fn as_ref(&self) -> &str

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

impl Borrow<DeviceId> for OwnedDeviceId

source§

fn borrow(&self) -> &DeviceId

Immutably borrows from an owned value. Read more
source§

impl Clone for Box<DeviceId>

source§

fn clone(&self) -> Self

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
source§

impl Debug for DeviceId

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for Box<DeviceId>

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for DeviceId

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&DeviceId> for Arc<DeviceId>

source§

fn from(s: &DeviceId) -> Arc<DeviceId>

Converts to this type from the input type.
source§

impl From<&DeviceId> for Box<DeviceId>

source§

fn from(id: &DeviceId) -> Self

Converts to this type from the input type.
source§

impl From<&DeviceId> for OwnedDeviceId

source§

fn from(id: &DeviceId) -> OwnedDeviceId

Converts to this type from the input type.
source§

impl From<&DeviceId> for Rc<DeviceId>

source§

fn from(s: &DeviceId) -> Rc<DeviceId>

Converts to this type from the input type.
source§

impl From<&DeviceId> for String

source§

fn from(id: &DeviceId) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a str> for &'a DeviceId

source§

fn from(s: &'a str) -> Self

Converts to this type from the input type.
source§

impl From<&str> for Box<DeviceId>

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl From<Box<str>> for Box<DeviceId>

source§

fn from(s: Box<str>) -> Self

Converts to this type from the input type.
source§

impl From<OwnedDeviceId> for Box<DeviceId>

source§

fn from(a: OwnedDeviceId) -> Box<DeviceId>

Converts to this type from the input type.
source§

impl From<String> for Box<DeviceId>

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl Hash for DeviceId

source§

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

Feeds this value into the given Hasher. Read more
source§

impl Ord for DeviceId

source§

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

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

impl PartialEq<&DeviceId> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<&DeviceId> for OwnedDeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<&str> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<&str> for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<Box<DeviceId>> for &DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<Box<DeviceId>> for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<DeviceId> for &str

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<DeviceId> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<DeviceId> for OwnedDeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<DeviceId> for String

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<DeviceId> for str

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<OwnedDeviceId> for &DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<OwnedDeviceId> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<OwnedDeviceId> for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<String> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<String> for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<str> for Box<DeviceId>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq<str> for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialEq for DeviceId

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd for DeviceId

source§

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

impl Serialize for DeviceId

source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl ToOwned for DeviceId

§

type Owned = OwnedDeviceId

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · source§

fn clone_into(&self, target: &mut Self::Owned)

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

impl Eq for DeviceId

source§

impl StructuralPartialEq for DeviceId

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

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

§

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

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.
source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more