qr

Documentation

Index

• Constants
• Variables
• type RecoveryLevel
• type Service

Constants

const (
	ErrorInvalidRecoveryLevel = "invalid recovery level requested"
	ErrorInvalidSize          = "invalid size requested"
	ErrorNoContent            = "content can't be empty"
	ErrorContentTooLarge      = "content size too large"
	ErrorGenerate             = "unable to generate QR"
)

QR Service Error descriptions

const ServiceName = "qr"

ServiceName of this service.

Variables

var (
	ErrInvalidRecoveryLevel = errors.New(ErrorInvalidRecoveryLevel)
	ErrInvalidSize          = errors.New(ErrorInvalidSize)
	ErrNoContent            = errors.New(ErrorNoContent)
	ErrContentTooLarge      = errors.New(ErrorContentTooLarge)
	ErrGenerate             = errors.New(ErrorGenerate)
)

QR Service Errors

Types

type RecoveryLevel

type RecoveryLevel int

RecoveryLevel : Error detection/recovery capacity. See: http://www.qrcode.com/en/about/error_correction.html

const (
	LevelL RecoveryLevel = iota // Level L: 7% error recovery.
	LevelM                      // Level M: 15% error recovery.
	LevelQ                      // Level Q: 25% error recovery.
	LevelH                      // Level H: 30% error recovery.
)

RecoveryLevel enum identifying QR Code Error Correction Capability

type Service

type Service interface {
	Generate(ctx context.Context, url string, level RecoveryLevel, size int) ([]byte, error)
}

Service describes our QR service.