examples/common/QRCode/repo/rust/Readme.markdown

   1 QR Code generator library
   2 =========================
   3
   4
   5 Introduction
   6 ------------
   7
   8 This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.
   9
  10 Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library
  11
  12
  13 Features
  14 --------
  15
  16 Core features:
  17
  18 * Available in 6 programming languages, all with nearly equal functionality: Java, TypeScript/JavaScript, Python, Rust, C++, C
  19 * Significantly shorter code but more documentation comments compared to competing libraries
  20 * Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
  21 * Output formats: Raw modules/pixels of the QR symbol, SVG XML string
  22 * Detects finder-like penalty patterns more accurately than other implementations
  23 * Encodes numeric and special-alphanumeric text in less space than general text
  24 * Open source code under the permissive MIT License
  25
  26 Manual parameters:
  27
  28 * User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data
  29 * User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one
  30 * User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number
  31 * User can create a list of data segments manually and add ECI segments
  32
  33
  34 Examples
  35 --------
  36
  37     extern crate qrcodegen;
  38     use qrcodegen::QrCode;
  39     use qrcodegen::QrCodeEcc;
  40     use qrcodegen::QrSegment;
  41
  42     // Simple operation
  43     let qr = QrCode::encode_text("Hello, world!",
  44         QrCodeEcc::Medium).unwrap();
  45     let svg = qr.to_svg_string(4);
  46
  47     // Manual operation
  48     let chrs: Vec<char> = "3141592653589793238462643383".chars().collect();
  49     let segs = QrSegment::make_segments(&chrs);
  50     let qr = QrCode::encode_segments_advanced(
  51         &segs, QrCodeEcc::High, 5, 5, Some(Mask::new(2)), false).unwrap();
  52     for y in 0 .. qr.size() {
  53         for x in 0 .. qr.size() {
  54             (... paint qr.get_module(x, y) ...)
  55         }
  56     }
  57
  58 More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/rust/examples/qrcodegen-demo.rs .