package coding

Import Path
	rsc.io/qr/coding (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d qr.go
		Package coding implements low-level QR coding details.
Package-Level Type Names (total 14, in which 12 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Alpha string (basic type)
		Alpha is the encoding for alphanumeric data.
		The valid characters are 0-9A-Z$%*+-./: and space.

		Methods (total 4, all are exported)
			( Alpha) Bits(v Version) int
			( Alpha) Check() error
			( Alpha) Encode(b *Bits, v Version)
			( Alpha) String() string
		Implements (at least 4, in which 2 are exported)
			 Alpha : Encoding
			 Alpha : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Alpha : context.stringer
			 Alpha : runtime.stringer

	 type Bits (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			b []byte
			nbit int
		Methods (total 7, all are exported)
			(*Bits) AddCheckBytes(v Version, l Level)
			(*Bits) Append(p []byte)
			(*Bits) Bits() int
			(*Bits) Bytes() []byte
			(*Bits) Pad(n int)
			(*Bits) Reset()
			(*Bits) Write(v uint, nbit int)
		As Inputs Of (at least 4, all are exported)
			func Alpha.Encode(b *Bits, v Version)
			func Encoding.Encode(b *Bits, v Version)
			func Num.Encode(b *Bits, v Version)
			func String.Encode(b *Bits, v Version)

	 type Code (struct)
		A Code is a square pixel grid.

		Fields (total 3, all are exported)
			Bitmap []byte
				// 1 is black, 0 is white

			Size int
				// number of pixels on a side

			Stride int
				// number of bytes per row

		Methods (only one, which is exported)
			(*Code) Black(x, y int) bool
		As Outputs Of (at least one exported)
			func (*Plan).Encode(text ...Encoding) (*Code, error)

	 type Encoding (interface)
		Encoding implements a QR data encoding scheme.
		The implementations--Numeric, Alphanumeric, and String--specify
		the character set and the mapping from UTF-8 to code bits.
		The more restrictive the mode, the fewer code bits are needed.

		Methods (total 3, all are exported)
			( Encoding) Bits(v Version) int
			( Encoding) Check() error
			( Encoding) Encode(b *Bits, v Version)
		Implemented By (at least 3, all are exported)
			 Alpha
			 Num
			 String
		As Inputs Of (at least one exported)
			func (*Plan).Encode(text ...Encoding) (*Code, error)

	 type Level int (basic type)
		A Level represents a QR error correction level.
		From least to most tolerant of errors, they are L, M, Q, H.

		Methods (only one, which is exported)
			( Level) String() string
		Implements (at least 3, in which 1 is exported)
			 Level : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Level : context.stringer
			 Level : runtime.stringer
		As Inputs Of (at least 5, in which 3 are exported)
			func NewPlan(version Version, level Level, mask Mask) (*Plan, error)
			func (*Bits).AddCheckBytes(v Version, l Level)
			func Version.DataBytes(l Level) int
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func fplan(l Level, m Mask, p *Plan) error
			func lplan(v Version, l Level, p *Plan) error
		As Types Of (total 4, all are exported)
			const H
			const L
			const M
			const Q

	 type Mask int (basic type)
		A Mask describes a mask that is applied to the QR
		code to avoid QR artifacts being interpreted as
		alignment and timing patterns (such as the squares
		in the corners).  Valid masks are integers from 0 to 7.

		Methods (only one, which is exported)
			( Mask) Invert(y, x int) bool
		As Inputs Of (at least 3, in which 1 is exported)
			func NewPlan(version Version, level Level, mask Mask) (*Plan, error)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func fplan(l Level, m Mask, p *Plan) error
			func mplan(m Mask, p *Plan) error

	 type Num string (basic type)
		Num is the encoding for numeric data.
		The only valid characters are the decimal digits 0 through 9.

		Methods (total 4, all are exported)
			( Num) Bits(v Version) int
			( Num) Check() error
			( Num) Encode(b *Bits, v Version)
			( Num) String() string
		Implements (at least 4, in which 2 are exported)
			 Num : Encoding
			 Num : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Num : context.stringer
			 Num : runtime.stringer

	 type Pixel uint32 (basic type)
		A Pixel describes a single pixel in a QR code.

		Methods (total 3, all are exported)
			( Pixel) Offset() uint
			( Pixel) Role() PixelRole
			( Pixel) String() string
		Implements (at least 3, in which 1 is exported)
			 Pixel : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Pixel : context.stringer
			 Pixel : runtime.stringer
		As Outputs Of (at least 3, in which 2 are exported)
			func OffsetPixel(o uint) Pixel
			func PixelRole.Pixel() Pixel
			/* at least one unexported ... *//* at least one unexported: */
			func grid(siz int) [][]Pixel
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func alignBox(m [][]Pixel, x, y int)
			func posBox(m [][]Pixel, x, y int)
		As Types Of (total 2, both are exported)
			const Black
			const Invert

	 type PixelRole uint32 (basic type)
		A PixelRole describes the role of a QR pixel.

		Methods (total 2, both are exported)
			( PixelRole) Pixel() Pixel
			( PixelRole) String() string
		Implements (at least 3, in which 1 is exported)
			 PixelRole : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 PixelRole : context.stringer
			 PixelRole : runtime.stringer
		As Outputs Of (at least one exported)
			func Pixel.Role() PixelRole
		As Types Of (total 9, all are exported)
			const Alignment
			const Check
			const Data
			const Extra
			const Format
			const Position
			const PVersion
			const Timing
			const Unused

	 type Plan (struct)
		A Plan describes how to construct a QR code
		with a specific version, level, and mask.

		Fields (total 7, all are exported)
			Blocks int
				// number of data blocks

			CheckBytes int
				// number of error correcting (checksum) bytes

			DataBytes int
				// number of data bytes

			Level Level
			Mask Mask
			Pixel [][]Pixel
				// pixel map

			Version Version
		Methods (only one, which is exported)
			(*Plan) Encode(text ...Encoding) (*Code, error)
		As Outputs Of (at least 2, in which 1 is exported)
			func NewPlan(version Version, level Level, mask Mask) (*Plan, error)
			/* at least one unexported ... *//* at least one unexported: */
			func vplan(v Version) (*Plan, error)
		As Inputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func fplan(l Level, m Mask, p *Plan) error
			func lplan(v Version, l Level, p *Plan) error
			func mplan(m Mask, p *Plan) error

	 type String string (basic type)
		String is the encoding for 8-bit data.  All bytes are valid.

		Methods (total 4, all are exported)
			( String) Bits(v Version) int
			( String) Check() error
			( String) Encode(b *Bits, v Version)
			( String) String() string
		Implements (at least 4, in which 2 are exported)
			 String : Encoding
			 String : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 String : context.stringer
			 String : runtime.stringer

	 type Version int (basic type)
		A Version represents a QR version.
		The version specifies the size of the QR code:
		a QR code with version v has 4v+17 pixels on a side.
		Versions number from 1 to 40: the larger the version,
		the more information the code can store.

		Methods (total 3, in which 2 are exported)
			( Version) DataBytes(l Level) int
				DataBytes returns the number of data bytes that can be
				stored in a QR code with the given version and level.

			( Version) String() string
			/* one unexported ... *//* one unexported: */
			( Version) sizeClass() int
		Implements (at least 3, in which 1 is exported)
			 Version : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Version : context.stringer
			 Version : runtime.stringer
		As Inputs Of (at least 12, in which 10 are exported)
			func NewPlan(version Version, level Level, mask Mask) (*Plan, error)
			func Alpha.Bits(v Version) int
			func Alpha.Encode(b *Bits, v Version)
			func (*Bits).AddCheckBytes(v Version, l Level)
			func Encoding.Bits(v Version) int
			func Encoding.Encode(b *Bits, v Version)
			func Num.Bits(v Version) int
			func Num.Encode(b *Bits, v Version)
			func String.Bits(v Version) int
			func String.Encode(b *Bits, v Version)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func lplan(v Version, l Level, p *Plan) error
			func vplan(v Version) (*Plan, error)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type level (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			check int
			nblock int

	 type version (struct)
		A version describes metadata associated with a version.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			apos int
			astride int
			bytes int
			level [4]level
			pattern int


Package-Level Functions (total 9, in which 2 are exported)

	 func NewPlan(version Version, level Level, mask Mask) (*Plan, error)
		NewPlan returns a Plan for a QR code with the given
		version, level, and mask.

	 func OffsetPixel(o uint) Pixel
	/* 7 unexporteds ... *//* 7 unexporteds: */
	 func alignBox(m [][]Pixel, x, y int)
		alignBox draw an alignment (small) box at upper left x, y.

	 func fplan(l Level, m Mask, p *Plan) error
		fplan adds the format pixels

	 func grid(siz int) [][]Pixel
	 func lplan(v Version, l Level, p *Plan) error
		lplan edits a version-only Plan to add information
		about the error correction levels.

	 func mplan(m Mask, p *Plan) error
		mplan edits a version+level-only Plan to add the mask.

	 func posBox(m [][]Pixel, x, y int)
		posBox draws a position (large) box at upper left x, y.

	 func vplan(v Version) (*Plan, error)
		vplan creates a Plan for the given version.


Package-Level Variables (total 7, in which 1 is exported)

	  var Field *gf256.Field
		Field is the field for QR error correction.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var alphaLen [3]int
	  var mfunc []func(int, int) bool
		http://www.swetake.com/qr/qr5_en.html

	  var numLen [3]int
	  var roles []string
	  var stringLen [3]int
	  var vtab []version
Package-Level Constants (total 18, in which 17 are exported)

	const Alignment PixelRole = 2 // alignment squares (small)
	const Black Pixel = 1
	const Check PixelRole = 8 // error correction check bit
	const Data PixelRole = 7 // data bit
	const Extra PixelRole = 9
	const Format PixelRole = 4 // format metadata
	const H Level = 3
	const Invert Pixel = 2
	const L Level = 0
	const M Level = 1
	const MaxVersion = 40
	const MinVersion = 1
	const Position PixelRole = 1 // position squares (large)
	const PVersion PixelRole = 5 // version pattern
	const Q Level = 2
	const Timing PixelRole = 3 // timing strip between position squares
	const Unused PixelRole = 6 // unused pixel
	/* one unexported ... *//* one unexported: */
	const alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:"

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.