tuv 0.1.0

Pure-Rust QR code encoder with SVG and PNG output
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! QR code generation library.
//!
//! **Tuv** is named for the three letters after QRS in the alphabet — a nod to QR
//! codes and the sequential nature of encoding.
//!
//! # Quick start
//!
//! ```
//! use tuv::QRCode;
//!
//! let qr = QRCode::new("Hello, world!", None, None).unwrap();
//! let svg = qr.to_svg(true);
//! let png = qr.to_png(300, true);
//! # let _ = (svg, png);
//! ```
//!
//! # Architecture
//!
//! ```text
//! Input -> Mode Select -> Reed-Solomon ECC -> Block Interleave
//!        -> Function Patterns -> Matrix -> Data Placement -> Masking
//!        -> Format Info -> SVG / PNG
//! ```

pub mod encoder;
pub mod error_correction;
pub mod matrix;
pub mod render;

pub mod qrcode;

// Public exports
pub use encoder::{Mode, Encoder};
pub use error_correction::ECCLevel;
pub use matrix::{QRMatrix, Module};
pub use qrcode::{QRCode, QRGenError};