Struct matrix_sdk::encryption::identities::MasterPubkey

pub struct MasterPubkey(/* private fields */);

Available on crate feature e2e-encryption only.

Expand description

Wrapper for a cross signing key marking it as the master key.

Master keys are used to sign other cross signing keys, the self signing and user signing keys of an user will be signed by their master key.

Implementations§

impl MasterPubkey

pub fn user_id(&self) -> &UserId

Get the user id of the master key’s owner.

pub fn keys(&self) -> &SigningKeys<OwnedDeviceKeyId>

Get the keys map of containing the master keys.

pub fn usage(&self) -> &[KeyUsage]

Get the list of KeyUsage that is set for this key.

pub fn signatures(&self) -> &Signatures

Get the signatures map of this cross signing key.

pub fn get_key(&self, key_id: &DeviceKeyId) -> Option<&SigningKey>

Get the master key with the given key id.

§Arguments

key_id - The id of the key that should be fetched.

pub fn get_first_key(&self) -> Option<Ed25519PublicKey>

Get the first available master key.

There’s usually only a single master key so this will usually fetch the only key.

Trait Implementations§

impl AsRef<CrossSigningKey> for MasterPubkey

fn as_ref(&self) -> &CrossSigningKey

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

impl Clone for MasterPubkey

fn clone(&self) -> MasterPubkey

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 Debug for MasterPubkey

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for MasterPubkey

fn deserialize<D>( deserializer: D ) -> Result<MasterPubkey, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<'a> IntoIterator for &'a MasterPubkey

type Item = (&'a OwnedDeviceKeyId, &'a SigningKey)

The type of the elements being iterated over.

type IntoIter = Iter<'a, OwnedDeviceKeyId, SigningKey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a MasterPubkey as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl PartialEq for MasterPubkey

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

The PartialEq implementation compares the user ID, the usage and the key material, ignoring signatures.

The usage could be safely ignored since the type guarantees it has the correct usage by construction – it is impossible to construct a value of a particular key type with an incorrect usage. However, we check it anyway, to codify the notion that the same key material with a different usage results in a logically different key.

The signatures are provided by other devices and don’t alter the identity of the key itself.

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 Serialize for MasterPubkey

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 TryFrom<CrossSigningKey> for MasterPubkey

type Error = Error

The type returned in the event of a conversion error.

fn try_from( key: CrossSigningKey ) -> Result<MasterPubkey, <MasterPubkey as TryFrom<CrossSigningKey>>::Error>

Performs the conversion.

impl Eq for MasterPubkey

Auto Trait Implementations§

impl RefUnwindSafe for MasterPubkey

impl Send for MasterPubkey

impl Sync for MasterPubkey

impl Unpin for MasterPubkey

impl UnwindSafe for MasterPubkey

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

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.

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.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

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.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Any for T
where T: Any,

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> CloneAny for T
where T: Any + Clone,

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> SendOutsideWasm for T
where T: Send,

impl<T> SyncOutsideWasm for T
where T: Sync,