• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1QR Code generator library
2=========================
3
4
5Introduction
6------------
7
8This 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
10Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library
11
12
13Features
14--------
15
16Core 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 format: Raw modules/pixels of the QR symbol
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
26Manual 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
34Examples
35--------
36
37    extern crate qrcodegen;
38    use qrcodegen::Mask;
39    use qrcodegen::QrCode;
40    use qrcodegen::QrCodeEcc;
41    use qrcodegen::QrSegment;
42    use qrcodegen::Version;
43
44    // Simple operation
45    let qr = QrCode::encode_text("Hello, world!",
46        QrCodeEcc::Medium).unwrap();
47    let svg = to_svg_string(&qr, 4);  // See qrcodegen-demo
48
49    // Manual operation
50    let chrs: Vec<char> = "3141592653589793238462643383".chars().collect();
51    let segs = QrSegment::make_segments(&chrs);
52    let qr = QrCode::encode_segments_advanced(&segs, QrCodeEcc::High,
53        Version::new(5), Version::new(5), Some(Mask::new(2)), false).unwrap();
54    for y in 0 .. qr.size() {
55        for x in 0 .. qr.size() {
56            (... paint qr.get_module(x, y) ...)
57        }
58    }
59
60More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/rust/examples/qrcodegen-demo.rs .
61