Namespace: go.std.encoding.base32

v1.0

Contents

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

Summary

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

Package base32 implements base32 encoding as specified by RFC 4648.

Index

• *CorruptInputError
• *Encoding
• CorruptInputError
• Encoding
• HexEncoding
• NewDecoder
• NewEncoder
• NewEncoding
• NoPadding
• StdEncoding
• StdPadding
• 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

• HexEncoding

  Var v1.0

  HexEncoding is the “Extended Hex Alphabet” defined in RFC 4648.
  It is typically used in DNS.
  

• StdEncoding

  Var v1.0

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

Functions, Macros, and Special Forms

• NewDecoder

  Function v1.0

  (NewDecoder enc r)
  

  NewDecoder constructs a new base32 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 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.
  
  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 Encoding defined by the given alphabet,
  which must be a 32-byte string.
  
  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 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

  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 base32 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 base32 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 base32-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 8 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 base32 encoding of src.
  

• EncodedLen

  Receiver for *Encoding v1.0

  ([n])
  

  EncodedLen returns the length in bytes of the base32 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 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.
  

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