Struct Symbol 

pub struct Symbol { /* private fields */ }

Available on crate features micro-qr or qr or rmqr only.

An immutable encoded QR Code, Micro QR Code or rMQR symbol.

Implementations

impl Symbol

pub const fn size(&self) -> usize

Returns the symbol width in modules.

The square QR Code and Micro QR Code families use this as the height as well, but Rectangular Micro QR Code symbols are not square, so read width and height separately for them.

pub const fn width(&self) -> usize

Returns the symbol width in modules.

pub const fn height(&self) -> usize

Returns the symbol height in modules.

pub const fn version(&self) -> SymbolVersion

Returns the encoded symbol version.

pub const fn error_correction(&self) -> SymbolErrorCorrection

Returns the error correction level written to the symbol.

pub const fn mask(&self) -> u8

Returns the selected mask number.

pub const fn structured_append(&self) -> Option<StructuredAppendInfo>

Available on crate feature qr only.

Returns Structured Append metadata when this symbol belongs to a sequence.

pub fn module(&self, x: usize, y: usize) -> Option<bool>

Returns a module or None when the coordinates are outside the symbol.

pub fn modules(&self) -> &[bool]

Returns every module as one row-major slice without copying.

A dark module is true, and the module at (x, y) is at index y * width + x.

pub fn to_matrix(&self) -> Vec<Vec<bool>>

Copies the symbol into a row-major Boolean matrix.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl PartialEq for Symbol

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Symbol