base64

Imports

Imports #

"encoding/binary"
"io"
"slices"
"strconv"

Constants & Variables

NoPadding const #

const NoPadding rune = *ast.UnaryExpr

RawStdEncoding var #

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 RawStdEncoding = *ast.CallExpr

RawURLEncoding var #

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 RawURLEncoding = *ast.CallExpr

StdEncoding var #

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

var StdEncoding = *ast.CallExpr

StdPadding const #

const StdPadding rune = '='

URLEncoding var #

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

var URLEncoding = *ast.CallExpr

decodeMapInitialize const #

const decodeMapInitialize = *ast.BinaryExpr

invalidIndex const #

const invalidIndex = '\xff'

Type Aliases

CorruptInputError type #

type CorruptInputError int64

Structs

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 /.

type Encoding struct {
encode [64]byte
decodeMap [256]uint8
padChar rune
strict bool
}

decoder struct #

type decoder struct {
err error
readErr error
enc *Encoding
r io.Reader
buf [1024]byte
nbuf int
out []byte
outbuf [*ast.BinaryExpr]byte
}

encoder struct #

type encoder struct {
err error
enc *Encoding
w io.Writer
buf [3]byte
nbuf int
out [1024]byte
}

newlineFilteringReader struct #

type newlineFilteringReader struct {
wrapped io.Reader
}

Functions

AppendDecode method #

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. New line characters (\r and \n) are ignored.

func (enc *Encoding) AppendDecode(dst []byte, src []byte) ([]byte, error)

AppendEncode method #

AppendEncode appends the base64 encoded src to dst and returns the extended buffer.

func (enc *Encoding) AppendEncode(dst []byte, src []byte) []byte

Close method #

Close flushes any pending output from the encoder. It is an error to call Write after calling Close.

func (e *encoder) Close() error

Decode method #

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. The caller must ensure that dst is large enough to hold all the decoded data. 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.

func (enc *Encoding) Decode(dst []byte, src []byte) (n int, err error)

DecodeString method #

DecodeString returns the bytes represented by the base64 string s. If the input is malformed, it returns the partially decoded data and [CorruptInputError]. New line characters (\r and \n) are ignored.

func (enc *Encoding) DecodeString(s string) ([]byte, error)

DecodedLen method #

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

func (enc *Encoding) DecodedLen(n int) int

Encode method #

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.

func (enc *Encoding) Encode(dst []byte, src []byte)

EncodeToString method #

EncodeToString returns the base64 encoding of src.

func (enc *Encoding) EncodeToString(src []byte) string

EncodedLen method #

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

func (enc *Encoding) EncodedLen(n int) int

Error method #

func (e CorruptInputError) Error() string

NewDecoder function #

NewDecoder constructs a new base64 stream decoder.

func NewDecoder(enc *Encoding, r io.Reader) io.Reader

NewEncoder function #

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 NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser

NewEncoding function #

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].

func NewEncoding(encoder string) *Encoding

Read method #

func (d *decoder) Read(p []byte) (n int, err error)

Read method #

func (r *newlineFilteringReader) Read(p []byte) (int, error)

Strict method #

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.

func (enc Encoding) Strict() *Encoding

WithPadding method #

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.

func (enc Encoding) WithPadding(padding rune) *Encoding

Write method #

func (e *encoder) Write(p []byte) (n int, err error)

assemble32 function #

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 assemble32(n1 byte, n2 byte, n3 byte, n4 byte) (dn uint32, ok bool)

assemble64 function #

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.

func assemble64(n1 byte, n2 byte, n3 byte, n4 byte, n5 byte, n6 byte, n7 byte, n8 byte) (dn uint64, ok bool)

decodeQuantum method #

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.

func (enc *Encoding) decodeQuantum(dst []byte, src []byte, si int) (nsi int, n int, err error)

decodedLen function #

func decodedLen(n int, padChar rune) int

Generated with Arrow