matrix-rust-sdk/matrix_qrcode
Damir Jelić 4c8412f4a1 docs(qrcode): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00
..
data matrix-sdk: Add a crate to generate and parse QR codes 2021-05-19 16:10:48 +02:00
src docs(qrcode): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00
Cargo.toml Upgrade to ruma 0.3.0 2021-08-12 10:41:20 +02:00
README.md docs(qrcode): Use the readme for the crate docs 2021-09-09 20:57:58 +02:00

README.md

matrix-qrcode is a crate to easily generate and parse QR codes for interactive verification using QR codes in Matrix.

Usage

This is probably not the crate you are looking for, it's used internally in the matrix-sdk.

If you still want to play with QR codes, here are a couple of helpful examples.

Decode an image

use image;
use matrix_qrcode::{QrVerificationData, DecodingError};

fn main() -> Result<(), DecodingError> {
    let image = image::open("/path/to/my/image.png").unwrap();
    let result = QrVerificationData::from_image(image)?;

    Ok(())
}

Encode into a QR code

use matrix_qrcode::{QrVerificationData, DecodingError};
use image::Luma;

fn main() -> Result<(), DecodingError> {
    let data = b"MATRIX\
        \x02\x02\x00\x07\
        FLOW_ID\
        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
        BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB\
        SHARED_SECRET";

    let data = QrVerificationData::from_bytes(data)?;
    let encoded = data.to_qr_code().unwrap();
    let image = encoded.render::<Luma<u8>>().build();

    Ok(())
}