Namespace: go.std.encoding.base64

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the encoding/base64 package.

Package base64 implements base64 encoding as specified by RFC 4648.

Index

• *CorruptInputError
• *Encoding
• CorruptInputError
• Encoding
• NewDecoder
• NewEncoder
• NewEncoding
• NoPadding
• RawStdEncoding
• RawURLEncoding
• StdEncoding
• StdPadding
• URLEncoding
• arrayOfCorruptInputError
• arrayOfEncoding

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

• NoPadding

  Char v1.0

  No padding
  

• StdPadding

  Char v1.0

  Standard padding character
  

Variables

• RawStdEncoding

  Var v1.0

  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.
  

• RawURLEncoding

  Var v1.0

  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.
  

• StdEncoding

  Var v1.0

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

• URLEncoding

  Var v1.0

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

Functions, Macros, and Special Forms

• NewDecoder

  Function v1.0

  (NewDecoder enc r)
  

  NewDecoder constructs a new base64 stream decoder.
  
  Go input arguments: (enc *Encoding, r io.Reader)
  
  Go returns: io.Reader
  
  Joker input arguments: [^*Encoding enc, ^go.std.io/Reader r]
  
  Joker returns: ^go.std.io/Reader

• NewEncoder

  Function v1.0

  (NewEncoder enc w)
  

  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.
  
  Go input arguments: (enc *Encoding, w io.Writer)
  
  Go returns: io.WriteCloser
  
  Joker input arguments: [^*Encoding enc, ^go.std.io/Writer w]
  
  Joker returns: ^go.std.io/WriteCloser

• NewEncoding

  Function v1.0

  (NewEncoding encoder)
  

  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 resulting Encoding uses the default padding character ('='),
  which may be changed or disabled via WithPadding.
  
  Go input arguments: (encoder string)
  
  Go returns: *Encoding
  
  Joker input arguments: [^String encoder]
  
  Joker returns: ^*Encoding

Types

• *CorruptInputError

  Concrete Type v1.0

• *Encoding

  Concrete Type v1.0

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

• Decode

  Receiver for *Encoding v1.0

  ([dst src])
  

  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.
  

• DecodeString

  Receiver for *Encoding v1.0

  ([s])
  

  DecodeString returns the bytes represented by the base64 string s.
  

• DecodedLen

  Receiver for *Encoding v1.0

  ([n])
  

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

• Encode

  Receiver for *Encoding v1.0

  ([dst src])
  

  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.
  

• EncodeToString

  Receiver for *Encoding v1.0

  ([src])
  

  EncodeToString returns the base64 encoding of src.
  

• EncodedLen

  Receiver for *Encoding v1.0

  ([n])
  

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

• CorruptInputError

  Concrete Type v1.0

• Error

  Receiver for CorruptInputError v1.0

  ([])
  

• Encoding

  Concrete Type v1.0

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

• Strict

  Receiver for Encoding v1.0

  ([])
  

  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.
  

• WithPadding

  Receiver for Encoding v1.0

  ([padding])
  

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

• arrayOfCorruptInputError

  Concrete Type v1.0

• arrayOfEncoding

  Concrete Type v1.0

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