Struct matrix_sdk_crypto::UserIdentity

source · [−]

pub struct UserIdentity { /* private fields */ }

Expand description

Struct representing a cross signing identity of a user.

This is the user identity of a user that isn’t our own. Other users will only contain a master key and a self signing key, meaning that only device signatures can be checked with this identity.

This struct wraps a read-only version of the struct and allows verifications to be requested to verify our own device with the user identity.

Implementations

source

impl UserIdentity

source

pub fn verified(&self) -> bool

Is this user identity verified.

source

pub async fn verify(&self) -> Result<SignatureUploadRequest, SignatureError>

Manually verify this user.

This method will attempt to sign the user identity using our private cross signing key.

This method fails if we don’t have the private part of our user-signing key.

Returns a request that needs to be sent out for the user to be marked as verified.

source

pub async fn request_verification(
 &self,
 room_id: &RoomId,
 request_event_id: &EventId,
 methods: Option<Vec<VerificationMethod>>
) -> VerificationRequest

Create a VerificationRequest object after the verification request content has been sent out.

source

pub async fn verification_request_content(
&self,
methods: Option<Vec<VerificationMethod>>
) -> KeyVerificationRequestEventContent

Send a verification request to the given user.

The returned content needs to be sent out into a DM room with the given user.

After the content has been sent out a VerificationRequest can be started with the request_verification() method.

Methods from Deref<Target = ReadOnlyUserIdentity>

source

pub fn user_id(&self) -> &UserId

Get the user id of this identity.

source

pub fn master_key(&self) -> &MasterPubkey

Get the public master key of the identity.

source

pub fn self_signing_key(&self) -> &SelfSigningPubkey

Get the public self-signing key of the identity.

Trait Implementations

source

impl Clone for UserIdentity

source

fn clone(&self) -> UserIdentity

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

source

impl Debug for UserIdentity

source

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

Formats the value using the given formatter. Read more

source

impl Deref for UserIdentity

type Target = ReadOnlyUserIdentity

The resulting type after dereferencing.

source

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

Dereferences the value.

source

impl From<UserIdentity> for UserIdentities

source

fn from(i: UserIdentity) -> Self

Converts to this type from the input type.

Auto Trait Implementations

impl !RefUnwindSafe for UserIdentity

impl Send for UserIdentity

impl Sync for UserIdentity

impl Unpin for UserIdentity

impl !UnwindSafe for UserIdentity

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

Struct matrix_sdk_crypto::UserIdentity

Implementations

impl UserIdentity

pub fn verified(&self) -> bool

pub async fn verify(&self) -> Result<SignatureUploadRequest, SignatureError>

pub async fn request_verification( &self, room_id: &RoomId, request_event_id: &EventId, methods: Option<Vec<VerificationMethod>>) -> VerificationRequest

pub async fn verification_request_content( &self, methods: Option<Vec<VerificationMethod>>) -> KeyVerificationRequestEventContent

Methods from Deref<Target = ReadOnlyUserIdentity>

pub fn user_id(&self) -> &UserId

pub fn master_key(&self) -> &MasterPubkey

pub fn self_signing_key(&self) -> &SelfSigningPubkey

Trait Implementations

impl Clone for UserIdentity

fn clone(&self) -> UserIdentity

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

impl Debug for UserIdentity

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

impl Deref for UserIdentity

type Target = ReadOnlyUserIdentity

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

impl From<UserIdentity> for UserIdentities

fn from(i: UserIdentity) -> Self

Auto Trait Implementations

impl !RefUnwindSafe for UserIdentity

impl Send for UserIdentity

impl Sync for UserIdentity

impl Unpin for UserIdentity

impl !UnwindSafe for UserIdentity

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> AsyncTraitDeps for T where T: Debug + Send + Sync,

pub async fn request_verification(
&self,
room_id: &RoomId,
request_event_id: &EventId,
methods: Option<Vec<VerificationMethod>>
) -> VerificationRequest

pub async fn verification_request_content(
&self,
methods: Option<Vec<VerificationMethod>>
) -> KeyVerificationRequestEventContent

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

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

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

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

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

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

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

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

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

impl<T> AsyncTraitDeps for T where
T: Debug + Send + Sync,