Struct BitMatrix 

pub struct BitMatrix { /* private fields */ }

A rectangular grid of dark (true) and light (false) modules.

The Debug implementation renders ASCII art, which makes failing tests readable at a glance.

Implementations

impl BitMatrix

pub fn new(width: u32, height: u32) -> Self

Create an all-light matrix.

Panics

Panics if width or height is zero, which no symbology should ever produce.

pub fn from_row(row: Vec<bool>) -> Self

Build a single-row matrix from a run of modules.

Panics

Panics if row is empty, which no symbology should ever produce. Use from_vec to get an Option instead.

pub fn from_vec(width: u32, height: u32, bits: Vec<bool>) -> Option<Self>

Build a matrix from row-major module data.

Returns None if bits.len() is not exactly width * height, or if either dimension is zero.

pub fn width(&self) -> u32

Width in modules.

pub fn height(&self) -> u32

Height in modules.

pub fn get(&self, x: u32, y: u32) -> bool

Whether the module at (x, y) is dark. Out-of-bounds reads as light.

pub fn set(&mut self, x: u32, y: u32, dark: bool)

Set the module at (x, y). Out-of-bounds writes are ignored.

pub fn row(&self, y: u32) -> &[bool]

One row of modules. An out-of-bounds row reads as empty, matching the way get and set tolerate out-of-bounds coordinates.

Trait Implementations

impl Clone for BitMatrix

fn clone(&self) -> BitMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitMatrix

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

Formats the value using the given formatter.

impl Eq for BitMatrix

impl PartialEq for BitMatrix

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BitMatrix