rqr 0.1.1

A small QR code generation project I made to dip my toes into rust again after several years of absence.
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
43
44
45
46
47
48
49
50
51
52
53

//! Provides a simple and safe API.

use crate::version::Version;
use crate::ec::ECLevel;
use crate::mode::Mode;
use crate::mask::Mask;
use crate::matrix::Matrix;
use crate::builder::*;

/// The QR code.
///
/// Encapsulates a matrix, the 2D-grid containing the QR modules
/// and some information about the QR code.
#[derive(Debug, PartialEq, Eq)]
pub struct Qr {
    /// Version of the QR code.
    pub version: Version,

    /// Error correction level.
    pub ecl: ECLevel,

    /// Encoding mode.
    pub mode: Mode,

    /// The modules.
    pub matrix: Matrix,

    /// The applied mask, 0 to 7.
    pub mask: Mask,
}

impl Qr {
    /// Create a new QR from a string.
    pub fn new(s: &str) -> Result<Qr, Error> {
        QrBuilder::new().into(s)
    }

    /// Create a new QR with specified error correction.
    pub fn with_ecl(s: &str, ecl: ECLevel) -> Result<Qr, Error> {
        QrBuilder::new().ecl(ecl).into(s)
    }

    /// Create a new QR with a specified version.
    pub fn with_version(s: &str, v: Version) -> Result<Qr, Error> {
        QrBuilder::new().version(v).into(s)
    }

    /// Returns the size of the QR code.
    pub fn size(&self) -> usize {
        self.version.size()
    }
}