package base64

Import Path
	encoding/base64 (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 6 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 2)

	/* sort by: alphabet | popularity */
	 type CorruptInputError int64 (basic type)

		Methods (only one)
			( 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 /.

		Methods (total 10)
			(*Encoding) AppendDecode(dst, src []byte) ([]byte, error)
				AppendDecode appends the base64 decoded src to dst
				and returns the extended buffer.
				If the input is malformed, it returns the partially decoded src and an error.

			(*Encoding) AppendEncode(dst, src []byte) []byte
				AppendEncode appends the base64 encoded src to dst
				and returns the extended buffer.

			(*Encoding) Decode(dst, src []byte) (n int, err error)
				Decode decodes src using the encoding enc. It writes at most
				[Encoding.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 [Encoding.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,
				must not be negative, 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.

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


Package-Level Functions (total 3)

	 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 contains unique byte values and
		does not contain the padding character or CR / LF ('\r', '\n').
		The alphabet is treated as a 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 [Encoding.WithPadding].


Package-Level Variables (total 4)

	  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 2)

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

The pages are generated with Golds v0.6.9-preview. (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.