Struct matrix_sdk::authentication::qrcode::QrCodeData

pub struct QrCodeData {
    pub public_key: Curve25519PublicKey,
    pub rendezvous_url: Url,
    pub mode_data: QrCodeModeData,
}

Available on crate feature experimental-oidc and crate feature e2e-encryption and non-WebAssembly only.

Data for the QR code login mechanism.

The QrCodeData can be serialized and encoded as a QR code or it can be decoded from a QR code.

Fields

public_key: Curve25519PublicKey

The ephemeral Curve25519 public key. Can be used to establish a shared secret using the Diffie-Hellman key agreement.

rendezvous_url: Url

The URL of the rendezvous session, can be used to exchange messages with the other device.

mode_data: QrCodeModeData

Mode specific data, may contain the homeserver URL.

Implementations

impl QrCodeData

pub fn from_bytes(bytes: &[u8]) -> Result<QrCodeData, LoginQrCodeDecodeError>

Attempt to decode a slice of bytes into a QrCodeData object.

The slice of bytes would generally be returned by a QR code decoder.

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

Encode the QrCodeData into a list of bytes.

The list of bytes can be used by a QR code generator to create an image containing a QR code.

pub fn from_base64(data: &str) -> Result<QrCodeData, LoginQrCodeDecodeError>

Attempt to decode a base64 encoded string into a QrCodeData object.

pub fn to_base64(&self) -> String

Encode the QrCodeData into a list of bytes.

The list of bytes can be used by a QR code generator to create an image containing a QR code.

pub fn mode(&self) -> QrCodeMode

Get the mode of this QrCodeData instance.

Trait Implementations

impl Clone for QrCodeData

fn clone(&self) -> QrCodeData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QrCodeData

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

Formats the value using the given formatter.

impl PartialEq for QrCodeData

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

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

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 Eq for QrCodeData

impl StructuralPartialEq for QrCodeData