qrcode2 0.18.0

A QR code encoding library
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

// SPDX-FileCopyrightText: 2014 kennytm
// SPDX-FileCopyrightText: 2024 Shun Sakai
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Implementation of [`Module`].

use crate::types::Color;

/// The color of a module (pixel) in the QR code.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Module {
    /// The module is empty.
    Empty,

    /// The module is of functional patterns which cannot be masked, or pixels
    /// which have been masked.
    Masked(Color),

    /// The module is of data and error correction bits before masking.
    Unmasked(Color),
}

impl From<Module> for Color {
    fn from(module: Module) -> Self {
        match module {
            Module::Empty => Self::Light,
            Module::Masked(c) | Module::Unmasked(c) => c,
        }
    }
}

impl Module {
    /// Checks whether a module is dark.
    #[must_use]
    pub fn is_dark(self) -> bool {
        Color::from(self) == Color::Dark
    }

    /// Applies a mask to the unmasked modules.
    ///
    /// # Examples
    ///
    /// ```
    /// # use qrcode2::{Color, canvas::Module};
    /// #
    /// assert_eq!(
    ///     Module::Unmasked(Color::Light).mask(true),
    ///     Module::Masked(Color::Dark)
    /// );
    /// assert_eq!(
    ///     Module::Unmasked(Color::Dark).mask(true),
    ///     Module::Masked(Color::Light)
    /// );
    /// assert_eq!(
    ///     Module::Unmasked(Color::Light).mask(false),
    ///     Module::Masked(Color::Light)
    /// );
    /// assert_eq!(
    ///     Module::Masked(Color::Dark).mask(true),
    ///     Module::Masked(Color::Dark)
    /// );
    /// assert_eq!(
    ///     Module::Masked(Color::Dark).mask(false),
    ///     Module::Masked(Color::Dark)
    /// );
    /// ```
    #[must_use]
    pub fn mask(self, should_invert: bool) -> Self {
        match (self, should_invert) {
            (Self::Empty, true) => Self::Masked(Color::Dark),
            (Self::Empty, false) => Self::Masked(Color::Light),
            (Self::Unmasked(c), true) => Self::Masked(!c),
            (Self::Unmasked(c), false) | (Self::Masked(c), _) => Self::Masked(c),
        }
    }
}