Struct fast_qr::qr::QRBuilder

source ·
pub struct QRBuilder { /* private fields */ }
Expand description

Builder struct, makes it easier to create a QRCode.

§Example

use fast_qr::QRBuilder;
use fast_qr::{Mask, ECL, Version};

// Creates a `QRCode` with a forced `version`, `ecl` and/or `mask`
let input = String::from("Hello World!");
let qr = QRBuilder::new(input)
    // .version(Version::V05)
    // .ecl(ECL::H)
    // .mask(Mask::Checkerboard)
    .build();

Implementations§

source§

impl QRBuilder

source

pub fn new<I: Into<Vec<u8>>>(input: I) -> QRBuilder

Creates an instance of QRBuilder with default parameters

source

pub fn mode(&mut self, mode: Mode) -> &mut Self

Forces the Mode

source

pub fn ecl(&mut self, ecl: ECL) -> &mut Self

Forces the Encoding Level

source

pub fn version(&mut self, version: Version) -> &mut Self

Forces the version

source

pub fn mask(&mut self, mask: Mask) -> &mut Self

Forces the mask, should very rarely be used

source

pub fn build(&self) -> Result<QRCode, QRCodeError>

Computes a QRCode with given parameters

§Errors
  • QRCodeError::EncodedData if input is too large to be encoded. See an online table for more info.
  • QRCodeError::SpecifiedVersion if specified version is too small to contain data

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.