Enum qr_code::canvas::Module

pub enum Module {
    Empty,
    Masked(Color),
    Unmasked(Color),
}

The color of a module (pixel) in the QR code.

Variants

Empty

The module is empty.

Masked(Color)

The module is of functional patterns which cannot be masked, or pixels which have been masked.

Unmasked(Color)

The module is of data and error correction bits before masking.

Implementations

impl Module

pub fn is_dark(self) -> bool

Checks whether a module is dark.

pub fn mask(self, should_invert: bool) -> Self

Apply a mask to the unmasked modules.

use qr_code::canvas::Module;
use qr_code::types::Color;

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));

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Module

impl Debug for Module

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

Formats the value using the given formatter.

impl Eq for Module

impl From<Module> for Color

fn from(module: Module) -> Self

Performs the conversion.

impl PartialEq<Module> for Module

fn eq(&self, other: &Module) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module) -> bool

This method tests for !=.

impl StructuralEq for Module

impl StructuralPartialEq for Module