qr

Documentation

Overview

Package qr can be used to create QR barcodes.

Index

• func Encode(content string, level ErrorCorrectionLevel, mode Encoding) (barcode.Barcode, error)
• func EncodeWithColor(content string, level ErrorCorrectionLevel, mode Encoding, ...) (barcode.Barcode, error)
• type Encoding
  • func (e Encoding) String() string
• type ErrorCorrectionLevel
  • func (ecl ErrorCorrectionLevel) String() string

Functions

func Encode

func Encode(content string, level ErrorCorrectionLevel, mode Encoding) (barcode.Barcode, error)

func EncodeWithColor

func EncodeWithColor(content string, level ErrorCorrectionLevel, mode Encoding, color barcode.ColorScheme) (barcode.Barcode, error)

Encode returns a QR barcode with the given content and color scheme, error correction level and uses the given encoding

Types

type Encoding

type Encoding byte

Encoding mode for QR Codes.

const (
	// Auto will choose ths best matching encoding
	Auto Encoding = iota
	// Numeric encoding only encodes numbers [0-9]
	Numeric
	// AlphaNumeric encoding only encodes uppercase letters, numbers and  [Space], $, %, *, +, -, ., /, :
	AlphaNumeric
	// Unicode encoding encodes the string as utf-8
	Unicode
)

func (Encoding) String

func (e Encoding) String() string

type ErrorCorrectionLevel

type ErrorCorrectionLevel byte

ErrorCorrectionLevel indicates the amount of "backup data" stored in the QR code

const (
	// L recovers 7% of data
	L ErrorCorrectionLevel = iota
	// M recovers 15% of data
	M
	// Q recovers 25% of data
	Q
	// H recovers 30% of data
	H
)

func (ErrorCorrectionLevel) String

func (ecl ErrorCorrectionLevel) String() string