Struct QrCode 

pub struct QrCode { /* private fields */ }

A finished QR symbol: a square grid of dark and light modules.

Implementations

impl QrCode

pub fn size(&self) -> usize

Side length in modules, 4 * version + 17.

pub fn version(&self) -> u8

The symbol version, 1 to 10.

pub fn ecc(&self) -> Ecc

The error-correction level the symbol was built at.

pub fn mask(&self) -> u8

Which of the eight data masks the penalty rules selected. Recorded in the format information, so a reader does not have to guess.

pub fn module(&self, x: usize, y: usize) -> bool

Whether the module at (x, y) is dark. Out-of-range coordinates read as light, which is what the quiet zone is anyway.

impl QrCode

pub fn to_svg_default(&self) -> String

Render as a standalone <svg> element, four pixels per module and a four-module quiet zone. The common case for an enrolment page.

pub fn to_svg(&self, module_pixels: u32, quiet_zone: u32) -> String

Render as a standalone <svg> element with a default title.

module_pixels is the on-screen size of one module and quiet_zone the margin around the symbol, in modules. The standard asks for at least four, and readers really do need it — a QR code butted up against surrounding content often will not scan.

pub fn to_svg_titled( &self, module_pixels: u32, quiet_zone: u32, title: &str, ) -> String

Render as a standalone <svg> element with a caller-supplied title.

The output deliberately contains no <style> element, no style attribute and no script: it is embedded in a page served under style-src 'self'; script-src 'self' with no unsafe-inline, so anything inline would simply be dropped by the browser and the code would render as a blank square. Colours are presentation attributes, which CSP does not police.

All of the dark modules go into one <path>, accumulated as horizontal runs. A version 10 symbol has 3249 modules, and one element each would be a document large enough to notice on every page load.

Trait Implementations

impl Clone for QrCode

fn clone(&self) -> QrCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QrCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.