Struct matrix_sdk::ruma::KeyId

pub struct KeyId<A, K>(/* private fields */)
where
    K: ?Sized;
Expand description

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>> ) -> Result<Box<KeyId<A, K>>, 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<[u8]> for Box<KeyId<A, K>>
where K: ?Sized,

§

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

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

impl<A, K> AsRef<[u8]> for KeyId<A, K>
where K: ?Sized,

§

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

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

impl<A, K> AsRef<KeyId<A, K>> for KeyId<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<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 Box<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> 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. Read more
§

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

§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

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. Read more
§

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

§

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

Deserialize this value from the given Serde deserializer. Read more
§

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. Read more
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

type Err = Error

The associated error which can be returned from parsing.
§

fn from_str( s: &str ) -> Result<Box<KeyId<A, K>>, <Box<KeyId<A, K>> as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

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. Read more
§

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. Read more
§

impl<A, K> PartialEq<&KeyId<A, K>> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq<&str> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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

§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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

§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq<KeyId<A, K>> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq<OwnedKeyId<A, K>> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq<String> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq<str> for Box<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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialEq 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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<A, K> PartialOrd 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. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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. Read more
§

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. Read more
1.63.0 · source§

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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>>
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>>, <Box<KeyId<A, K>> as TryFrom<&str>>::Error>

Performs the conversion.
§

impl<A, K> TryFrom<String> for Box<KeyId<A, K>>
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>>, <Box<KeyId<A, K>> as TryFrom<String>>::Error>

Performs the conversion.
§

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

Auto Trait Implementations§

§

impl<A, K: ?Sized> RefUnwindSafe for KeyId<A, K>

§

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

§

impl<A, K> !Sized for KeyId<A, K>

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more