chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

identifiers: Improve doctest layout and use type aliases

Browse Source
This commit is contained in:
Andy Balaam 2024-11-01 15:48:45 +00:00 committed by strawberry
parent 9ff70228d8
commit c471070933
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
crates/ruma-common/src/identifiers/key_id.rs
View File

@ -15,12 +15,14 @@ use super::{
/// ///
/// Examples of the use of this struct are [`DeviceKeyId`], which identifies a Ed25519 or Curve25519 /// Examples of the use of this struct are [`DeviceKeyId`], which identifies a Ed25519 or Curve25519
/// [device key](https://spec.matrix.org/v1.12/client-server-api/#device-keys), and /// [device key](https://spec.matrix.org/v1.12/client-server-api/#device-keys), and
/// [`CrossSigningKeyId`], which identifies a user's [cross signing key](https://spec.matrix.org/v1.12/client-server-api/#cross-signing). /// [`CrossSigningKeyId`], which identifies a user's
/// [cross signing key](https://spec.matrix.org/v1.12/client-server-api/#cross-signing).
/// ///
/// This format of identifier is often used in the `signatures` field of [signed JSON](https://spec.matrix.org/v1.12/appendices/#signing-details) /// This format of identifier is often used in the `signatures` field of
/// [signed JSON](https://spec.matrix.org/v1.12/appendices/#signing-details)
/// where it is referred to as a "signing key identifier". /// 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 typedefs /// 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`]. /// that rely on it like [`CrossSigningKeyId`] or [`DeviceSigningKeyId`].
/// ///
/// # Examples /// # Examples
@ -29,7 +31,8 @@ use super::{
/// ///
/// ```rust /// ```rust
/// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId}; /// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId};
/// let k: OwnedKeyId<DeviceKeyAlgorithm, DeviceId> = KeyId::parse("ed25519:1").unwrap(); ///
/// let k: OwnedDeviceKeyId = KeyId::parse("ed25519:1").unwrap();
/// assert_eq!(k.algorithm().as_str(), "ed25519"); /// assert_eq!(k.algorithm().as_str(), "ed25519");
/// assert_eq!(k.key_name(), "1"); /// assert_eq!(k.key_name(), "1");
/// ``` /// ```
@ -38,8 +41,8 @@ use super::{
/// ///
/// ```rust /// ```rust
/// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId}; /// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId};
/// let k: OwnedKeyId<DeviceKeyAlgorithm, DeviceId> = ///
/// KeyId::from_parts(DeviceKeyAlgorithm::Curve25519, "MYDEVICE".into()); /// let k: OwnedDeviceKeyId = KeyId::from_parts(DeviceKeyAlgorithm::Curve25519, "MYDEVICE".into());
/// assert_eq!(k.to_string(), "curve25519:MYDEVICE"); /// assert_eq!(k.to_string(), "curve25519:MYDEVICE");
/// ``` /// ```
#[repr(transparent)] #[repr(transparent)]
@ -69,7 +72,8 @@ impl<A: KeyAlgorithm, K: KeyName + ?Sized> KeyId<A, K> {
/// ///
/// ```rust /// ```rust
/// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId}; /// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId};
/// let k: OwnedKeyId<DeviceKeyAlgorithm, DeviceId> = KeyId::parse("ed25519:1").unwrap(); ///
/// let k: OwnedDeviceKeyId = KeyId::parse("ed25519:1").unwrap();
/// assert_eq!(k.algorithm().as_str(), "ed25519"); /// assert_eq!(k.algorithm().as_str(), "ed25519");
/// ``` /// ```
pub fn algorithm(&self) -> A { pub fn algorithm(&self) -> A {
@ -82,7 +86,8 @@ impl<A: KeyAlgorithm, K: KeyName + ?Sized> KeyId<A, K> {
/// ///
/// ```rust /// ```rust
/// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId}; /// use ruma_common::{DeviceId, DeviceKeyAlgorithm, KeyId, OwnedKeyId};
/// let k: OwnedKeyId<DeviceKeyAlgorithm, DeviceId> = KeyId::parse("ed25519:foo").unwrap(); ///
/// let k: OwnedDeviceKeyId = KeyId::parse("ed25519:foo").unwrap();
/// assert_eq!(k.key_name(), "foo"); /// assert_eq!(k.key_name(), "foo");
/// ``` /// ```
pub fn key_name<'a>(&'a self) -> &'a K pub fn key_name<'a>(&'a self) -> &'a K