Struct QrCodeBuilder

pub struct QrCodeBuilder<'a, 'b> { /* private fields */ }

Builder for generating QR Codes.

Generates a QR Code in the form of a Result<Vec<u8>, Error> and overlay a logo on top of it. The Vec<u8> is generated according to image::ImageOutputFormat::Png.

Argument requirements

• The content should not be empty.
• The size should be between SIZE_MIN and SIZE_MAX (their values might change in future releases).

Note that these are only checked in QrCodeBuilder::build.

Defaults

• bg_color and logo_bg_color default to white.
• size defaults to DEFAULT_SIZE.

Examples

let logo = include_bytes!("../../assets/logo.png");
use qr_rs_lib::{QrCodeBuilder, Rgb};

let qr_code = QrCodeBuilder::new("github.com", logo)
  .with_size(600)
  .with_bg_color(Rgb([255, 0, 0]))
  .build();

assert!(matches!(qr_code, Ok(_)));

Implementations

impl<'a, 'b> QrCodeBuilder<'a, 'b>

pub const fn new(content: &'a str, logo: &'b [u8]) -> QrCodeBuilder<'a, 'b>

Construct a new QR Code builder given the contents of the QR Code and the logo to use.

Everything else is optional.

pub fn with_size(&mut self, size: u32) -> &mut Self

Sets the dimensions of the QR Code to size x size.

pub fn with_bg_color(&mut self, bg_color: Rgb) -> &mut Self

Sets the background color of the QR Code. The caller is responsible for ensuring that the end result is readable.

Defaults to white.

pub fn with_logo_bg_color(&mut self, logo_bg_color: Rgb) -> &mut Self

Sets the background color of the padding around the logo. The caller is responsible for ensuring that the end result is readable.

Defaults to white.

pub fn build(&self) -> Result<Vec<u8>, Error>

Constructs the QR Code.

The argument requirements are applied here, hence the Result return type.

Trait Implementations

impl<'a, 'b> Debug for QrCodeBuilder<'a, 'b>

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

Formats the value using the given formatter.