modo-rs 0.8.0

Rust web framework for small monolithic apps
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
37
38
39
40
41
42

//! # modo::qrcode
//!
//! QR code generation with customizable SVG output.
//!
//! Generates QR codes from any string and renders them as SVG with
//! configurable module shapes, finder shapes, and colors. Primary use
//! case is TOTP authenticator enrollment, but the module is
//! general-purpose.
//!
//! ## Provides
//!
//! - [`QrCode`] — generated QR matrix; call [`QrCode::to_svg`] to render.
//! - [`QrStyle`] — rendering options: module shape, finder shape, colors, sizes.
//! - [`Ecl`] — error correction level (Low / Medium / Quartile / High).
//! - [`Color`] — foreground/background color as hex string or RGB tuple.
//! - [`ModuleShape`] — shape of data modules (Square, RoundedSquare, Circle, Diamond).
//! - [`FinderShape`] — shape of finder patterns (Square, Rounded, Circle).
//! - [`QrError`] — error type for generation and rendering failures.
//! - [`qr_svg_function`] — MiniJinja template function factory.
//!
//! ## Quick start
//!
//! ```rust,no_run
//! use modo::qrcode::{QrCode, QrStyle};
//!
//! let qr = QrCode::new("https://example.com").unwrap();
//! let svg = qr.to_svg(&QrStyle::default()).unwrap();
//! assert!(svg.starts_with("<svg"));
//! ```

mod code;
mod error;
mod render;
mod style;

pub use code::{Ecl, QrCode};
pub use error::QrError;
pub use style::{Color, FinderShape, ModuleShape, QrStyle};

mod template;

pub use template::qr_svg_function;