Struct DeviceId

pub struct DeviceId(/* private fields */);

A Matrix device 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

impl DeviceId

pub fn as_str(&self) -> &str

Creates a string slice from this DeviceId.

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

Creates a byte slice from this DeviceId.

impl DeviceId

pub fn new() -> OwnedDeviceId

Available on crate feature rand only.

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

Trait Implementations

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

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

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

impl AsRef<[u8]> for DeviceId

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

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

impl AsRef<DeviceId> for DeviceId

fn as_ref(&self) -> &DeviceId

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

impl AsRef<DeviceId> for OwnedDeviceId

fn as_ref(&self) -> &DeviceId

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

impl AsRef<str> for Box<DeviceId>

fn as_ref(&self) -> &str

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

impl AsRef<str> for DeviceId

fn as_ref(&self) -> &str

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

impl Borrow<DeviceId> for OwnedDeviceId

fn borrow(&self) -> &DeviceId

Immutably borrows from an owned value.

impl Clone for Box<DeviceId>

fn clone(&self) -> Box<DeviceId>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceId

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DeviceId

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

Formats the value using the given formatter.

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

fn from(value: &'a DeviceId) -> &'a Base64PublicKeyOrDeviceId

Converts to this type from the input type.

impl From<&DeviceId> for Arc<DeviceId>

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

Converts to this type from the input type.

impl From<&DeviceId> for Box<DeviceId>

fn from(id: &DeviceId) -> Box<DeviceId>

Converts to this type from the input type.

impl From<&DeviceId> for OwnedDeviceId

fn from(id: &DeviceId) -> OwnedDeviceId

Converts to this type from the input type.

impl From<&DeviceId> for Rc<DeviceId>

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

Converts to this type from the input type.

impl From<&DeviceId> for String

fn from(id: &DeviceId) -> String

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&str> for Box<DeviceId>

fn from(s: &str) -> Box<DeviceId>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<OwnedDeviceId> for Box<DeviceId>

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

Converts to this type from the input type.

impl From<String> for Box<DeviceId>

fn from(s: String) -> Box<DeviceId>

Converts to this type from the input type.

impl Hash for DeviceId

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

where __H: Hasher,

Feeds this value into the given Hasher.

impl KeyName for DeviceId

fn validate(_s: &str) -> Result<(), Error>

Validate the given string for this name.

impl Ord for DeviceId

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

This method returns an Ordering between self and other.

impl PartialEq<&DeviceId> for Box<DeviceId>

fn eq(&self, other: &&DeviceId) -> 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<&DeviceId> for OwnedDeviceId

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

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<&str> for DeviceId

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<Box<DeviceId>> for &DeviceId

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

fn eq(&self, other: &Box<DeviceId>) -> 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<DeviceId> for &str

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

fn eq(&self, other: &DeviceId) -> 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<DeviceId> for OwnedDeviceId

fn eq(&self, other: &DeviceId) -> 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<DeviceId> for String

fn eq(&self, other: &DeviceId) -> 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<DeviceId> for str

fn eq(&self, other: &DeviceId) -> 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<OwnedDeviceId> for &DeviceId

fn eq(&self, other: &OwnedDeviceId) -> 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<OwnedDeviceId> for Box<DeviceId>

fn eq(&self, other: &OwnedDeviceId) -> 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<OwnedDeviceId> for DeviceId

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

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<String> for DeviceId

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 Box<DeviceId>

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<str> for DeviceId

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 DeviceId

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

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

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 ToOwned for DeviceId

type Owned = OwnedDeviceId

The resulting type after obtaining ownership.

fn to_owned(&self) -> <DeviceId as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

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

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

impl Eq for DeviceId

impl StructuralPartialEq for DeviceId