Struct ruma::KeyId

#[repr(transparent)]
pub struct KeyId<A, K>(_, _) 
where
    K: ?Sized;

A key algorithm and key name delimited by a colon.

Implementations

impl<A, K> KeyId<A, K> where
    K: ?Sized, 

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, K> KeyId<A, K> where
    K: ?Sized, 

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

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, Global>>
) -> Result<Box<KeyId<A, K>, Global>, Error>

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<KeyId<A, K>>, Error>

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

pub fn parse_arc(
    s: impl AsRef<str> + Into<Arc<str>>
) -> Result<Arc<KeyId<A, K>>, Error>

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

impl<A, K> KeyId<A, K> where
    K: ?Sized, 

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

Creates a new KeyId from an algorithm and key name.

pub fn algorithm(&self) -> A where
    A: FromStr, 

Returns key algorithm of the key ID.

pub fn key_name<'a>(&'a self) -> &'a K where
    &'a K: From<&'a str>, 

Returns the key name of the key ID.

Trait Implementations

impl<A, K> AsRef<KeyId<A, K>> for OwnedKeyId<A, K> where
    K: ?Sized, 

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

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

impl<A, K> AsRef<str> for KeyId<A, K> where
    K: ?Sized, 

fn as_ref(&self) -> &str

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

impl<A, K> Borrow<KeyId<A, K>> for OwnedKeyId<A, K> where
    K: ?Sized, 

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

Immutably borrows from an owned value.

impl<A, K> Clone for Box<KeyId<A, K>, Global> where
    K: ?Sized, 

fn clone(&self) -> Box<KeyId<A, K>, Global>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A, K> Debug for KeyId<A, K> where
    K: ?Sized, 

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

Formats the value using the given formatter.

impl<'de, A, K> Deserialize<'de> for Box<KeyId<A, K>, Global> where
    K: ?Sized, 

fn deserialize<D>(
    deserializer: D
) -> Result<Box<KeyId<A, K>, Global>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<A, K> Display for KeyId<A, K> where
    K: ?Sized, 

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

Formats the value using the given formatter.

impl<'_, A, K> From<&KeyId<A, K>> for OwnedKeyId<A, K> where
    K: ?Sized, 

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

Converts to this type from the input type.

impl<'_, A, K> From<&KeyId<A, K>> for String where
    K: ?Sized, 

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

Converts to this type from the input type.

impl<'_, A, K> From<&KeyId<A, K>> for Box<KeyId<A, K>, Global> where
    K: ?Sized, 

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

Converts to this type from the input type.

impl<'_, A, K> From<&KeyId<A, K>> for Rc<KeyId<A, K>> where
    K: ?Sized, 

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

Converts to this type from the input type.

impl<'_, A, K> From<&KeyId<A, K>> for Arc<KeyId<A, K>> where
    K: ?Sized, 

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

Converts to this type from the input type.

impl<A, K> Hash for KeyId<A, K> where
    K: ?Sized, 

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, 

Feeds a slice of this type into the given Hasher.

impl<A, K> Ord for KeyId<A, K> where
    K: ?Sized, 

fn cmp(&self, other: &KeyId<A, K>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'_, A, K> PartialEq<&KeyId<A, K>> for OwnedKeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &&KeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, A, K> PartialEq<&str> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, A, K> PartialEq<Box<KeyId<A, K>, Global>> for &KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &Box<KeyId<A, K>, Global>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<Box<KeyId<A, K>, Global>> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &Box<KeyId<A, K>, Global>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, A, K> PartialEq<KeyId<A, K>> for &str where
    K: ?Sized, 

fn eq(&self, other: &KeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<KeyId<A, K>> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &KeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<KeyId<A, K>> for OwnedKeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &KeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<KeyId<A, K>> for str where
    K: ?Sized, 

fn eq(&self, other: &KeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, A, K> PartialEq<OwnedKeyId<A, K>> for &KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &OwnedKeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<OwnedKeyId<A, K>> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &OwnedKeyId<A, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<String> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialEq<str> for KeyId<A, K> where
    K: ?Sized, 

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A, K> PartialOrd<KeyId<A, K>> for KeyId<A, K> where
    K: ?Sized, 

fn partial_cmp(&self, other: &KeyId<A, K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A, K> Serialize for KeyId<A, K> where
    K: ?Sized, 

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<A, K> ToOwned for KeyId<A, K> where
    K: ?Sized, 

type Owned = OwnedKeyId<A, K>

The resulting type after obtaining ownership.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: &'a str
) -> Result<&'a KeyId<A, K>, <&'a KeyId<A, K> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'_, A, K> TryFrom<&str> for Box<KeyId<A, K>, Global> where
    K: ?Sized, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: &str
) -> Result<Box<KeyId<A, K>, Global>, <Box<KeyId<A, K>, Global> as TryFrom<&str>>::Error>

Performs the conversion.

impl<A, K> TryFrom<String> for Box<KeyId<A, K>, Global> where
    K: ?Sized, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    s: String
) -> Result<Box<KeyId<A, K>, Global>, <Box<KeyId<A, K>, Global> as TryFrom<String>>::Error>

Performs the conversion.

impl<A, K> Eq for KeyId<A, K> where
    K: ?Sized,