Struct rqrr::Grid

pub struct Grid<G> {
    pub grid: G,
    pub bounds: [Point; 4],
}

Wrapper around any grid that can be interpreted as a QR code

Fields

grid: G

The backing binary square

bounds: [Point; 4]

The bounds of the square, in underlying coordinates.

If this grid references for example an underlying image, these values will be set to coordinates in that image.

Implementations

impl<G> Grid<G> where
    G: BitGrid, 

pub fn new(grid: G) -> Self

Create a new grid from a BitGrid.

This just initialises the bounds to 0.

pub fn decode(&self) -> Result<(MetaData, String), DeQRError>

Try to decode the grid.

If successful returns the decoded string as well as metadata about the code.

pub fn decode_to<W>(&self, writer: W) -> Result<MetaData, DeQRError> where
    W: Write, 

Try to decode the grid.

Instead of returning a String, this methode writes the decoded result to the given writer

Warning: This may lead to half decoded content to be written to the writer.

Trait Implementations

impl<G: Clone> Clone for Grid<G>

fn clone(&self) -> Grid<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug> Debug for Grid<G>

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

Formats the value using the given formatter.