Struct ruma_common::KeyId

pub struct KeyId<A: KeyAlgorithm, K: KeyName + ?Sized>(/* private fields */);

A key algorithm and key name delimited by a colon.

Examples of the use of this struct are DeviceKeyId, which identifies a Ed25519 or Curve25519 device key, and CrossSigningKeyId, which identifies a user’s cross signing key.

This format of identifier is often used in the signatures field of signed JSON where it is referred to as a “signing key identifier”.

This struct is rarely used directly - instead you should expect to use one of the type aliases that rely on it like CrossSigningKeyId or DeviceSigningKeyId.

Examples

To parse a colon-separated identifier:

use ruma_common::DeviceKeyId;

let k = DeviceKeyId::parse("ed25519:1").unwrap();
assert_eq!(k.algorithm().as_str(), "ed25519");
assert_eq!(k.key_name(), "1");

To construct a colon-separated identifier from its parts:

use ruma_common::{DeviceKeyAlgorithm, DeviceKeyId};

let k = DeviceKeyId::from_parts(DeviceKeyAlgorithm::Curve25519, "MYDEVICE".into());
assert_eq!(k.as_str(), "curve25519:MYDEVICE");

Implementations

impl<A: KeyAlgorithm, K: KeyName + ?Sized> KeyId<A, K>

pub fn as_str(&self) -> &str

Creates a string slice from this KeyId.

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

Creates a byte slice from this KeyId.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> KeyId<A, K>

pub fn parse(s: impl AsRef<str>) -> Result<OwnedKeyId<A, K>, IdParseError>

Try parsing a &str into an OwnedKeyId.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_box( s: impl AsRef<str> + Into<Box<str>>, ) -> Result<Box<Self>, IdParseError>

Try parsing a &str into a Box<KeyId>.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_rc( s: impl AsRef<str> + Into<Rc<str>>, ) -> Result<Rc<Self>, IdParseError>

Try parsing a &str into an Rc<KeyId>.

pub fn parse_arc( s: impl AsRef<str> + Into<Arc<str>>, ) -> Result<Arc<Self>, IdParseError>

Try parsing a &str into an Arc<KeyId>.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> KeyId<A, K>

pub fn from_parts(algorithm: A, key_name: &K) -> OwnedKeyId<A, K>

Creates a new KeyId from an algorithm and key name.

pub fn algorithm(&self) -> A

Returns key algorithm of the key ID - the part that comes before the colon.

Example

use ruma_common::{DeviceKeyAlgorithm, DeviceKeyId};

let k = DeviceKeyId::parse("ed25519:1").unwrap();
assert_eq!(k.algorithm(), DeviceKeyAlgorithm::Ed25519);

pub fn key_name<'a>(&'a self) -> &'a K

where &'a K: TryFrom<&'a str>,

Returns the key name of the key ID - the part that comes after the colon.

Example

use ruma_common::{device_id, DeviceKeyId};

let k = DeviceKeyId::parse("ed25519:DEV1").unwrap();
assert_eq!(k.key_name(), device_id!("DEV1"));

Trait Implementations

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<[u8]> for Box<KeyId<A, K>>

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

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<[u8]> for KeyId<A, K>

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

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<KeyId<A, K>> for KeyId<A, K>

fn as_ref(&self) -> &KeyId<A, K>

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<KeyId<A, K>> for OwnedKeyId<A, K>

fn as_ref(&self) -> &KeyId<A, K>

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<str> for Box<KeyId<A, K>>

fn as_ref(&self) -> &str

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> AsRef<str> for KeyId<A, K>

fn as_ref(&self) -> &str

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Borrow<KeyId<A, K>> for OwnedKeyId<A, K>

fn borrow(&self) -> &KeyId<A, K>

Immutably borrows from an owned value.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Clone for Box<KeyId<A, K>>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Debug for KeyId<A, K>

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

Formats the value using the given formatter.

impl<'de, A: KeyAlgorithm, K: KeyName + ?Sized> Deserialize<'de> for Box<KeyId<A, K>>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Display for KeyId<A, K>

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

Formats the value using the given formatter.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<&KeyId<A, K>> for Arc<KeyId<A, K>>

fn from(s: &KeyId<A, K>) -> Arc<KeyId<A, K>>

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<&KeyId<A, K>> for Box<KeyId<A, K>>

fn from(id: &KeyId<A, K>) -> Self

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<&KeyId<A, K>> for OwnedKeyId<A, K>

fn from(id: &KeyId<A, K>) -> OwnedKeyId<A, K>

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<&KeyId<A, K>> for Rc<KeyId<A, K>>

fn from(s: &KeyId<A, K>) -> Rc<KeyId<A, K>>

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<&KeyId<A, K>> for String

fn from(id: &KeyId<A, K>) -> Self

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> From<OwnedKeyId<A, K>> for Box<KeyId<A, K>>

fn from(a: OwnedKeyId<A, K>) -> Box<KeyId<A, K>>

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> FromStr for Box<KeyId<A, K>>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Hash for KeyId<A, K>

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

Feeds this value into the given Hasher.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Ord for KeyId<A, K>

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

This method returns an Ordering between self and other.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<&KeyId<A, K>> for Box<KeyId<A, K>>

fn eq(&self, other: &&KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<&KeyId<A, K>> for OwnedKeyId<A, K>

fn eq(&self, other: &&KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<&str> for Box<KeyId<A, K>>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<&str> for KeyId<A, K>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<Box<KeyId<A, K>>> for &KeyId<A, K>

fn eq(&self, other: &Box<KeyId<A, K>>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<Box<KeyId<A, K>>> for KeyId<A, K>

fn eq(&self, other: &Box<KeyId<A, K>>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<KeyId<A, K>> for &str

fn eq(&self, other: &KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<KeyId<A, K>> for Box<KeyId<A, K>>

fn eq(&self, other: &KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<KeyId<A, K>> for OwnedKeyId<A, K>

fn eq(&self, other: &KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<KeyId<A, K>> for String

fn eq(&self, other: &KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<KeyId<A, K>> for str

fn eq(&self, other: &KeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<OwnedKeyId<A, K>> for &KeyId<A, K>

fn eq(&self, other: &OwnedKeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<OwnedKeyId<A, K>> for Box<KeyId<A, K>>

fn eq(&self, other: &OwnedKeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<OwnedKeyId<A, K>> for KeyId<A, K>

fn eq(&self, other: &OwnedKeyId<A, K>) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<String> for Box<KeyId<A, K>>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<String> for KeyId<A, K>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<str> for Box<KeyId<A, K>>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<str> for KeyId<A, K>

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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq for KeyId<A, K>

fn eq(&self, other: &Self) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> PartialOrd for KeyId<A, K>

fn partial_cmp(&self, other: &Self) -> 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<A: KeyAlgorithm, K: KeyName + ?Sized> Serialize for KeyId<A, K>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> ToOwned for KeyId<A, K>

type Owned = OwnedKeyId<A, K>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::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<'a, A: KeyAlgorithm, K: KeyName + ?Sized> TryFrom<&'a str> for &'a KeyId<A, K>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> TryFrom<&str> for Box<KeyId<A, K>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> TryFrom<String> for Box<KeyId<A, K>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> Eq for KeyId<A, K>