Struct matrix_sdk::verification::QrVerification

pub struct QrVerification { /* fields omitted */ }

This is supported on encryption only.

An object controlling QR code style key verification flows.

Implementations

impl QrVerification

pub fn own_user_id(&self) -> &UserId

Get our own user id.

pub fn is_self_verification(&self) -> bool

Is this a verification that is veryfying one of our own devices.

pub fn is_done(&self) -> bool

Has this verification finished.

pub fn we_started(&self) -> bool

Did we initiate the verification flow.

pub fn cancel_info(&self) -> Option<CancelInfo>

Get info about the cancellation if the verification flow has been cancelled.

pub fn other_user_id(&self) -> &UserId

Get the user id of the other user participating in this verification flow.

pub fn is_cancelled(&self) -> bool

Has the verification been cancelled.

pub fn to_qr_code(&self) -> Result<QrCode, EncodingError>

Generate a QR code object that is representing this verification flow.

The QrCode can then be rendered as an image or as an unicode string.

The to_bytes() method can be used to instead output the raw bytes that should be encoded as a QR code.

pub fn to_bytes(&self) -> Result<Vec<u8>, EncodingError>

Generate a the raw bytes that should be encoded as a QR code is representing this verification flow.

The to_qr_code() method can be used to instead output a QrCode object that can be rendered.

pub async fn confirm(&self) -> Result<()>

Confirm that the other side has scanned our QR code.

pub async fn cancel(&self) -> Result<()>

Abort the verification flow and notify the other side that we did so.

Trait Implementations

impl Clone for QrVerification

fn clone(&self) -> QrVerification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QrVerification

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

Formats the value using the given formatter.

impl From<QrVerification> for Verification

fn from(qr: QrVerification) -> Self

Performs the conversion.