package base64

Import Path
	encoding/base64 (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 13 packages

Involved Source Files

	  d base64.go
		Package base64 implements base64 encoding as specified by RFC 4648.
Code Examples

	
		package main
		
		import (
			"encoding/base64"
			"fmt"
		)
		
		func main() {
			msg := "Hello, 世界"
			encoded := base64.StdEncoding.EncodeToString([]byte(msg))
			fmt.Println(encoded)
			decoded, err := base64.StdEncoding.DecodeString(encoded)
			if err != nil {
				fmt.Println("decode error:", err)
				return
			}
			fmt.Println(string(decoded))
		}

	Encoding_Decode
		package main
		
		import (
			"encoding/base64"
			"fmt"
		)
		
		func main() {
			str := "SGVsbG8sIHdvcmxkIQ=="
			dst := make([]byte, base64.StdEncoding.DecodedLen(len(str)))
			n, err := base64.StdEncoding.Decode(dst, []byte(str))
			if err != nil {
				fmt.Println("decode error:", err)
				return
			}
			dst = dst[:n]
			fmt.Printf("%q\n", dst)
		}

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

	Encoding_Encode
		package main
		
		import (
			"encoding/base64"
			"fmt"
		)
		
		func main() {
			data := []byte("Hello, world!")
			dst := make([]byte, base64.StdEncoding.EncodedLen(len(data)))
			base64.StdEncoding.Encode(dst, data)
			fmt.Println(string(dst))
		}

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

	NewEncoder
		package main
		
		import (
			"encoding/base64"
			"os"
		)
		
		func main() {
			input := []byte("foo\x00bar")
			encoder := base64.NewEncoder(base64.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: alphabet | popularity */
	 type CorruptInputError int64 (basic type)

		Methods (only one, which is exported)
			( CorruptInputError) Error() string
		Implements (at least one exported)
			 CorruptInputError : error

	 type Encoding (struct)
		An Encoding is a radix 64 encoding/decoding scheme, defined by a
		64-character alphabet. The most common encoding is the "base64"
		encoding defined in RFC 4648 and used in MIME (RFC 2045) and PEM
		(RFC 1421).  RFC 4648 also defines an alternate encoding, which is
		the standard encoding with - and _ substituted for + and /.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			decodeMap [256]byte
			encode [64]byte
			padChar rune
			strict bool
		Methods (total 9, in which 8 are exported)
			(*Encoding) Decode(dst, src []byte) (n int, err error)
				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 base64 data, it will return the
				number of bytes successfully written and CorruptInputError.
				New line characters (\r and \n) are ignored.

			(*Encoding) DecodeString(s string) ([]byte, error)
				DecodeString returns the bytes represented by the base64 string s.

			(*Encoding) DecodedLen(n int) int
				DecodedLen returns the maximum length in bytes of the decoded data
				corresponding to n bytes of base64-encoded data.

			(*Encoding) Encode(dst, src []byte)
				Encode encodes src using the encoding enc, writing
				EncodedLen(len(src)) bytes to dst.
				
				The encoding pads the output to a multiple of 4 bytes,
				so Encode is not appropriate for use on individual blocks
				of a large data stream. Use NewEncoder() instead.

			(*Encoding) EncodeToString(src []byte) string
				EncodeToString returns the base64 encoding of src.

			(*Encoding) EncodedLen(n int) int
				EncodedLen returns the length in bytes of the base64 encoding
				of an input buffer of length n.

			( Encoding) Strict() *Encoding
				Strict creates a new encoding identical to enc except with
				strict decoding enabled. In this mode, the decoder requires that
				trailing padding bits are zero, as described in RFC 4648 section 3.5.
				
				Note that the input is still malleable, as new line characters
				(CR and LF) are still ignored.

			( Encoding) WithPadding(padding rune) *Encoding
				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'.
				Padding characters above '\x7f' are encoded as their exact byte value
				rather than using the UTF-8 representation of the codepoint.

			/* one unexported ... *//* one unexported: */
			(*Encoding) decodeQuantum(dst, src []byte, si int) (nsi, n int, err error)
				decodeQuantum decodes up to 4 base64 bytes. The received parameters are
				the destination buffer dst, the source buffer src and an index in the
				source buffer si.
				It returns the number of bytes read from src, the number of bytes written
				to dst, and an error, if any.

		As Outputs Of (at least 3, all are exported)
			func NewEncoding(encoder string) *Encoding
			func Encoding.Strict() *Encoding
			func Encoding.WithPadding(padding rune) *Encoding
		As Inputs Of (at least 2, both are exported)
			func NewDecoder(enc *Encoding, r io.Reader) io.Reader
			func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
		As Types Of (total 4, all are exported)
			  var RawStdEncoding *Encoding
			  var RawURLEncoding *Encoding
			  var StdEncoding *Encoding
			  var URLEncoding *Encoding

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type decoder (struct)

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			buf [1024]byte
				// leftover input

			enc *Encoding
			err error
			nbuf int
			out []byte
				// leftover decoded output

			outbuf [768]byte
			r io.Reader
			readErr error
				// error from r.Read

		Methods (only one, which is exported)
			(*decoder) Read(p []byte) (n int, err error)
		Implements (at least one exported)
			*decoder : io.Reader

	 type encoder (struct)

		Fields (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			buf [3]byte
				// buffered data waiting to be encoded

			enc *Encoding
			err error
			nbuf int
				// number of bytes in buf

			out [1024]byte
				// output buffer

			w io.Writer
		Methods (total 2, both are exported)
			(*encoder) Close() error
				Close flushes any pending output from the encoder.
				It is an error to call Write after calling Close.

			(*encoder) Write(p []byte) (n int, err error)
		Implements (at least 5, in which 4 are exported)
			*encoder : internal/bisect.Writer
			*encoder : io.Closer
			*encoder : io.WriteCloser
			*encoder : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			*encoder : crypto/tls.transcriptHash

	 type newlineFilteringReader (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			wrapped io.Reader
		Methods (only one, which is exported)
			(*newlineFilteringReader) Read(p []byte) (int, error)
		Implements (at least one exported)
			*newlineFilteringReader : io.Reader


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

	 func NewDecoder(enc *Encoding, r io.Reader) io.Reader
		NewDecoder constructs a new base64 stream decoder.

	 func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
		NewEncoder returns a new base64 stream encoder. Data written to
		the returned writer will be encoded using enc and then written to w.
		Base64 encodings operate in 4-byte blocks; when finished
		writing, the caller must Close the returned encoder to flush any
		partially written blocks.

	 func NewEncoding(encoder string) *Encoding
		NewEncoding returns a new padded Encoding defined by the given alphabet,
		which must be a 64-byte string that does not contain the padding character
		or CR / LF ('\r', '\n'). The alphabet is treated as sequence of byte values
		without any special treatment for multi-byte UTF-8.
		The resulting Encoding uses the default padding character ('='),
		which may be changed or disabled via WithPadding.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func assemble32(n1, n2, n3, n4 byte) (dn uint32, ok bool)
		assemble32 assembles 4 base64 digits into 3 bytes.
		Each digit comes from the decode map, and will be 0xff
		if it came from an invalid character.

	 func assemble64(n1, n2, n3, n4, n5, n6, n7, n8 byte) (dn uint64, ok bool)
		assemble64 assembles 8 base64 digits into 6 bytes.
		Each digit comes from the decode map, and will be 0xff
		if it came from an invalid character.


Package-Level Variables (total 4, all are exported)

	  var RawStdEncoding *Encoding
		RawStdEncoding is the standard raw, unpadded base64 encoding,
		as defined in RFC 4648 section 3.2.
		This is the same as StdEncoding but omits padding characters.

	  var RawURLEncoding *Encoding
		RawURLEncoding is the unpadded alternate base64 encoding defined in RFC 4648.
		It is typically used in URLs and file names.
		This is the same as URLEncoding but omits padding characters.

	  var StdEncoding *Encoding
		StdEncoding is the standard base64 encoding, as defined in
		RFC 4648.

	  var URLEncoding *Encoding
		URLEncoding is the alternate base64 encoding defined in RFC 4648.
		It is typically used in URLs and file names.


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

	const NoPadding rune = -1 // No padding
	const StdPadding rune = 61 // Standard padding character
	/* 3 unexporteds ... *//* 3 unexporteds: */
	const decodeMapInitialize = "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff...
	const encodeStd = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
	const encodeURL = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"

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.