Struct OwnedKeyId 

pub struct OwnedKeyId<A: KeyAlgorithm, K: KeyName + ?Sized> { /* private fields */ }

Owned variant of KeyId

Inner representation

By default, this type uses a Box<str> internally. The inner representation can be selected at compile time by using one of the following supported values:

• Arc – Use an Arc<str>.

The selected value can be set by using the ruma_identifiers_storage compile-time cfg setting. This setting can be configured using the RUSTFLAGS environment variable at build time, like this:

RUSTFLAGS="--cfg ruma_identifiers_storage=\"{value}\""

Or in .cargo/config.toml:

# General setting for all targets, overridden by per-target `rustflags` setting if set.
[build]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

# Per-target setting.
[target.<triple/cfg>]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

This setting can also be configured using the RUMA_IDENTIFIERS_STORAGE environment variable at compile time, which has the benefit of not requiring to re-compile the whole dependency chain when the value is changed, like this:

RUMA_IDENTIFIERS_STORAGE="{value}"

Implementations

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

pub fn zeroize(self)

Securely zero memory (aka zeroize) of OwnedKeyId.

This method zeroizes this type by writing zeros in its memory location before freeing it. It internally uses the zeroize crate. Note that this type doesn’t implement the zeroize::Zeroize trait because the Zeroize::zeroize method takes a &mut self, which means we could put this type into an inconsistent state if it is used after calling that method. Instead, this method takes ownership of the type, ensuring it’s impossible to misuse it.

Implementation details

If the ruma_identifiers_storage configuration is set to Arc, this type will be zeroized if and only if Arc::get_mut returns Some reference, i.e. if there is no other Arc or Weak pointers to this same location.

Methods from Deref<Target = KeyId<A, K>>

pub fn as_str(&self) -> &str

Extracts a string slice from this KeyId.

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

Extracts a byte slice from this KeyId.

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::{DeviceKeyId, device_id};

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

Trait Implementations

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<[u8]> for OwnedKeyId<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<str> for OwnedKeyId<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> Borrow<str> for OwnedKeyId<A, K>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Target = KeyId<A, K>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, A: KeyAlgorithm, K: KeyName + ?Sized> Deserialize<'de> for OwnedKeyId<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 OwnedKeyId<A, K>

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

Formats the value using the given formatter.

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

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

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> FromStr for OwnedKeyId<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 OwnedKeyId<A, K>

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

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq for OwnedKeyId<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> 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 OwnedKeyId<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, A: KeyAlgorithm, K: KeyName + ?Sized> PartialEq<Cow<'a, str>> for OwnedKeyId<A, K>

fn eq(&self, other: &Cow<'a, 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<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<OwnedKeyId<A, K>> for str

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

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 String

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

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<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 OwnedKeyId<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 OwnedKeyId<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> PartialOrd for OwnedKeyId<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 OwnedKeyId<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> TryFrom<&str> for OwnedKeyId<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<Box<str>> for OwnedKeyId<A, K>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, A: KeyAlgorithm, K: KeyName + ?Sized> TryFrom<Cow<'a, str>> for OwnedKeyId<A, K>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: KeyAlgorithm, K: KeyName + ?Sized> TryFrom<String> for OwnedKeyId<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.