package base32

Import Path
	encoding/base32 (on golang.org and go.dev)

Dependency Relation
	imports 2 packages, and imported by one package


Involved Source Files

	
		Package base32 implements base32 encoding as specified by RFC 4648.


Code Examples

	
		package main
		
		import (
			"encoding/base32"
			"fmt"
		)
		
		func main() {
			str := "ONXW2ZJAMRQXIYJAO5UXI2BAAAQGC3TEEDX3XPY="
			data, err := base32.StdEncoding.DecodeString(str)
			if err != nil {
				fmt.Println("error:", err)
				return
			}
			fmt.Printf("%q\n", data)
		}


	
		package main
		
		import (
			"encoding/base32"
			"fmt"
		)
		
		func main() {
			data := []byte("any + old & data")
			str := base32.StdEncoding.EncodeToString(data)
			fmt.Println(str)
		}


	
		package main
		
		import (
			"encoding/base32"
			"os"
		)
		
		func main() {
			input := []byte("foo\x00bar")
			encoder := base32.NewEncoder(base32.StdEncoding, os.Stdout)
			encoder.Write(input)
			// Must close the encoder when finished to flush any partial blocks.
			// If you comment out the following line, the last partial block "r"
			// won't be encoded.
			encoder.Close()
		}




Package-Level Type Names (total 5, in which 2 are exported)


	/* sort exporteds by:  |  */
	

		
			( T) Error() string
		
			 T : error


	
		An Encoding is a radix 32 encoding/decoding scheme, defined by a
		32-character alphabet. The most common is the "base32" encoding
		introduced for SASL GSSAPI and standardized in RFC 4648.
		The alternate "base32hex" encoding is used in DNSSEC.

		
			
		
			
				Decode decodes src using the encoding enc. It writes at most
				DecodedLen(len(src)) bytes to dst and returns the number of bytes
				written. If src contains invalid base32 data, it will return the
				number of bytes successfully written and CorruptInputError.
				New line characters (\r and \n) are ignored.

			
				DecodeString returns the bytes represented by the base32 string s.

			
				DecodedLen returns the maximum length in bytes of the decoded data
				corresponding to n bytes of base32-encoded data.

			
				Encode encodes src using the encoding enc, writing
				EncodedLen(len(src)) bytes to dst.

				The encoding pads the output to a multiple of 8 bytes,
				so Encode is not appropriate for use on individual blocks
				of a large data stream. Use NewEncoder() instead.

			
				EncodeToString returns the base32 encoding of src.

			
				EncodedLen returns the length in bytes of the base32 encoding
				of an input buffer of length n.

			
				WithPadding creates a new encoding identical to enc except
				with a specified padding character, or NoPadding to disable padding.
				The padding character must not be '\r' or '\n', must not
				be contained in the encoding's alphabet and must be a rune equal or
				below '\xff'.

			
		
			func NewEncoding(encoder string) *Encoding
			func Encoding.WithPadding(padding rune) *Encoding
		
			func NewDecoder(enc *Encoding, r io.Reader) io.Reader
			func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
		
			  var HexEncoding *Encoding
			  var StdEncoding *Encoding


	


Package-Level Functions (total 5, in which 3 are exported)


	
		NewDecoder constructs a new base32 stream decoder.


	
		NewEncoder returns a new base32 stream encoder. Data written to
		the returned writer will be encoded using enc and then written to w.
		Base32 encodings operate in 5-byte blocks; when finished
		writing, the caller must Close the returned encoder to flush any
		partially written blocks.


	
		NewEncoding returns a new Encoding defined by the given alphabet,
		which must be a 32-byte string.


	


Package-Level Variables (total 2, both are exported)


	
		HexEncoding is the ``Extended Hex Alphabet'' defined in RFC 4648.
		It is typically used in DNS.


	
		StdEncoding is the standard base32 encoding, as defined in
		RFC 4648.




Package-Level Constants (total 4, in which 2 are exported)


	const NoPadding rune = -1 // No padding
	const StdPadding rune = 61 // Standard padding character