qrism 0.1.0

A Rust library for generating and reading QR codes with Reed-Solomon error correction. Supports traditional monochromatic QR codes with additional experimental multicolor QR support for enhanced storage capacity.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use std::fmt::{Debug, Display, Error, Formatter};

// Error
//------------------------------------------------------------------------------

#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum QRError {
    // QR builder
    EmptyData,
    DataTooLong,
    CapacityOverflow,
    InvalidVersion,
    InvalidECLevel,
    InvalidColor,
    InvalidChar,
    InvalidMaskingPattern,

    // QR reader
    SingularMatrix,
    PointAtInfinity,
    SymbolNotFound,
    CastingFailed,
    PixelOutOfBounds,
    TooManyError,
    InvalidInfo,
    InvalidFormatInfo,
    InvalidVersionInfo,
    InvalidCapacityInfo,
    FinderMismatch,
    TimingMismatch,
    AlignmentMismatch,
    DivisionByZero,
    InvalidMode(u8),
    CorruptDataSegment,
    EndOfStream,
    InvalidUTF8Encoding,
    InvalidCharacterEncoding,
}

impl Display for QRError {
    fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
        let msg = match *self {
            // QR builder
            Self::EmptyData => "Empty data",
            Self::DataTooLong => "Data too long",
            Self::CapacityOverflow => "Capacity overflow",
            Self::InvalidVersion => "Invalid version",
            Self::InvalidECLevel => "Invalid error correction level",
            Self::InvalidColor => "Invalid color",
            Self::InvalidChar => "Invalid character",
            Self::InvalidMaskingPattern => "Invalid masking pattern",

            // QR reader
            Self::SingularMatrix => "Cannot compute homography",
            Self::PointAtInfinity => "Projected point is at infinity",
            Self::SymbolNotFound => "QR not found",
            Self::CastingFailed => "f64 to i32 casting failed",
            Self::PixelOutOfBounds => "Pixel is out of bounds",
            Self::TooManyError => "Too many errors",
            Self::InvalidInfo => "Invalid info",
            Self::InvalidFormatInfo => "Invalid format info detected",
            Self::InvalidVersionInfo => "Invalid version info detected",
            Self::InvalidCapacityInfo => "Couldn't read capacity",
            Self::FinderMismatch => "Finder color mismatch",
            Self::TimingMismatch => "Timing color mismatch",
            Self::AlignmentMismatch => "Alignment color mismatch",
            Self::DivisionByZero => "Division by zero in GF(256)",
            Self::InvalidMode(m) => &format!("Unexpected mode bits: {m}").to_string(),
            Self::CorruptDataSegment => "Truncated data segment",
            Self::EndOfStream => "End of stream reached",
            Self::InvalidUTF8Encoding => "Invalid UTF8 sequence",
            Self::InvalidCharacterEncoding => "Character sequence is neither utf8 nor shift jis",
        };
        f.write_str(msg)
    }
}

impl std::error::Error for QRError {}

pub type QRResult<T> = Result<T, QRError>;