Example qr for website example.com

fast_qr is approximately 6-7 times faster than qrcode, see benchmarks

You can create a QR as

Usage

Converts QRCode to Unicode

```rust use fastqr::convert::ConvertError; use fastqr::convert::{svg::SvgBuilder, Builder, Shape}; use fast_qr::qr::QRBuilder;

fn main() -> Result<(), ConvertError> { // QRBuilde::new can fail if content is too big for version, // please check before unwrapping. let qrcode = QRBuilder::new("https://example.com/".into()) .build() .unwrap();

let str = qrcode.to_str(); // .print() exists
println!("{}", str);

Ok(())

} ```

Converts QRCode to SVG docs.rs

```rust use fastqr::convert::ConvertError; use fastqr::convert::{svg::SvgBuilder, Builder, Shape}; use fast_qr::qr::QRBuilder;

fn main() -> Result<(), ConvertError> { // QRBuilde::new can fail if content is too big for version, // please check before unwrapping. let qrcode = QRBuilder::new("https://example.com/".into()) .build() .unwrap();

let _svg = SvgBuilder::default()
    .shape(Shape::RoundedSquare)
    .to_file(&qrcode, "out.svg");

Ok(())

} ```

Converts QRCode to an image docs.rs

```rust use fastqr::convert::ConvertError; use fastqr::convert::{image::ImageBuilder, Builder, Shape}; use fast_qr::qr::QRBuilder;

fn main() -> Result<(), ConvertError> { // QRBuilde::new can fail if content is too big for version, // please check before unwrapping. let qrcode = QRBuilder::new("https://example.com/".into()) .build() .unwrap();

let _img = ImageBuilder::default()
    .shape(Shape::RoundedSquare)
    .fit_width(600)
    .to_file(&qrcode, "out.png");

Ok(())

} ```

Build WASM

WASM module also exists in NPM registry

Package is named fast_qr and can be installed like so :

npm install --save fast_qr

WASM module might be bundled

Find a bundled version in the latest release.

WASM module can be built from source

bash wasm-pack build --target web # All ready in ./pkg wasm-opt -Os -o pkg/fast_qr_bg.wasm pkg/fast_qr_bg.wasm # Optimizes wasm module size wasm-pack pack pkg # Generates the package to be published wasm-pack publish # you might need to `npm login`

Note: I found that wasm-opt doesn't always work, so I download the binary from WebAssembly/binaryen.

Benchmarks

According to the following benchmarks, fast_qr is approximately 6-7x faster than qrcode.

| Benchmark | Lower | Estimate | Upper | | | :----------- | :-------: | :-------: | :-------: | ----------------------- | | V03H/qrcode | 524.30 us | 535.02 us | 547.13 us | | | V03H/fastqr | 82.079 us | 82.189 us | 82.318 us | fastqr is 6.51x faster | | V10H/qrcode | 2.1105 ms | 2.1145 ms | 2.1186 ms | | | V10H/fastqr | 268.70 us | 269.28 us | 269.85 us | fastqr is 7.85x faster | | V40H/qrcode | 18.000 ms | 18.037 ms | 18.074 ms | | | V40H/fastqr | 2.4313 ms | 2.4362 ms | 2.4411 ms | fastqr is 7.40x faster |

More benchmarks can be found in /benches folder.