Struct ruma::Base64PublicKeyOrDeviceId

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

A Matrix ID that can be either a DeviceId or a Base64PublicKey.

Device identifiers in Matrix are completely opaque character sequences and cross-signing keys are identified by their base64-encoded public key. This type is provided simply for its semantic value.

It is not recommended to construct this type directly, it should instead be converted from a DeviceId or a Base64PublicKey.

Example

use ruma_common::{Base64PublicKeyOrDeviceId, OwnedBase64PublicKeyOrDeviceId};

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

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

Implementations

impl Base64PublicKeyOrDeviceId

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this Base64PublicKeyOrDeviceId.

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

Available on crate feature events only.

Creates a byte slice from this Base64PublicKeyOrDeviceId.

Trait Implementations

impl AsRef<[u8]> for Base64PublicKeyOrDeviceId

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

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

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

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

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

impl AsRef<Base64PublicKeyOrDeviceId> for Base64PublicKeyOrDeviceId

fn as_ref(&self) -> &Base64PublicKeyOrDeviceId

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

impl AsRef<Base64PublicKeyOrDeviceId> for OwnedBase64PublicKeyOrDeviceId

fn as_ref(&self) -> &Base64PublicKeyOrDeviceId

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

impl AsRef<str> for Base64PublicKeyOrDeviceId

fn as_ref(&self) -> &str

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

impl AsRef<str> for Box<Base64PublicKeyOrDeviceId>

fn as_ref(&self) -> &str

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

impl Borrow<Base64PublicKeyOrDeviceId> for OwnedBase64PublicKeyOrDeviceId

fn borrow(&self) -> &Base64PublicKeyOrDeviceId

Immutably borrows from an owned value.

impl Clone for Box<Base64PublicKeyOrDeviceId>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Base64PublicKeyOrDeviceId

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Base64PublicKeyOrDeviceId

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<&Base64PublicKeyOrDeviceId> for Arc<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl From<&Base64PublicKeyOrDeviceId> for Box<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl From<&Base64PublicKeyOrDeviceId> for OwnedBase64PublicKeyOrDeviceId

fn from(id: &Base64PublicKeyOrDeviceId) -> OwnedBase64PublicKeyOrDeviceId

Converts to this type from the input type.

impl From<&Base64PublicKeyOrDeviceId> for Rc<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl From<&Base64PublicKeyOrDeviceId> for String

fn from(id: &Base64PublicKeyOrDeviceId) -> String

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&str> for Box<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl From<Box<str>> for Box<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl From<OwnedBase64PublicKeyOrDeviceId> for Box<Base64PublicKeyOrDeviceId>

fn from(a: OwnedBase64PublicKeyOrDeviceId) -> Box<Base64PublicKeyOrDeviceId>

Converts to this type from the input type.

impl From<String> for Box<Base64PublicKeyOrDeviceId>

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

Converts to this type from the input type.

impl Hash for Base64PublicKeyOrDeviceId

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

where __H: Hasher,

Feeds this value into the given Hasher.

impl KeyName for Base64PublicKeyOrDeviceId

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

Validate the given string for this name.

impl Ord for Base64PublicKeyOrDeviceId

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

This method returns an Ordering between self and other.

impl PartialEq<&Base64PublicKeyOrDeviceId> for Box<Base64PublicKeyOrDeviceId>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Base64PublicKeyOrDeviceId

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

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 Base64PublicKeyOrDeviceId

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

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

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 Base64PublicKeyOrDeviceId

type Owned = OwnedBase64PublicKeyOrDeviceId

The resulting type after obtaining ownership.

fn to_owned(&self) -> <Base64PublicKeyOrDeviceId 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 Base64PublicKeyOrDeviceId

impl StructuralPartialEq for Base64PublicKeyOrDeviceId