Enum Verification

#[non_exhaustive]
pub enum Verification {
    SasV1(SasVerification),
    QrV1(QrVerification),
}

Available on crate feature e2e-encryption only.

An enum over the different verification types the SDK supports.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SasV1(SasVerification)

The m.sas.v1 verification variant.

QrV1(QrVerification)

Available on crate feature qrcode only.

The m.qr_code.*.v1 verification variant.

Implementations

impl Verification

pub fn sas(self) -> Option<SasVerification>

Try to deconstruct this verification enum into a SAS verification.

pub fn qr(self) -> Option<QrVerification>

Available on crate feature qrcode only.

Try to deconstruct this verification enum into a QR code verification.

pub fn is_done(&self) -> bool

Has this verification finished.

pub fn is_cancelled(&self) -> bool

Has the verification been cancelled.

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

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

pub fn own_user_id(&self) -> &UserId

Get our own user id.

pub fn other_user_id(&self) -> &UserId

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

pub fn is_self_verification(&self) -> bool

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

pub fn we_started(&self) -> bool

Did we initiate the verification flow.

pub fn room_id(&self) -> Option<&RoomId>

Get the room ID, if the verification is happening inside a room.

Trait Implementations

impl Clone for Verification

fn clone(&self) -> Verification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Verification

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

Formats the value using the given formatter.

impl From<QrVerification> for Verification

Available on crate feature qrcode only.

fn from(qr: QrVerification) -> Self

Converts to this type from the input type.

impl From<SasVerification> for Verification

fn from(sas: SasVerification) -> Self

Converts to this type from the input type.