encoding

Documentation

Index

• Variables
• func RegisterEncoding(e Encoding, f func() EncodingFunc) error
• type Encoding
  • func (e Encoding) Available() bool
  • func (e Encoding) EncodingFunc() Encoding
  • func (e Encoding) New() EncodingFunc
  • func (e Encoding) String() string
• type EncodingFunc

Variables

var (
	Encodings = make([]func() EncodingFunc, maxEncoding)
)

Functions

func RegisterEncoding

func RegisterEncoding(e Encoding, f func() EncodingFunc) error

RegisterEncoding registers a function that returns a new instance of the given Encoding function. This is intended to be called from the init function in packages that implement Encoding functions.

Types

type Encoding

type Encoding uint

const (
	None Encoding = iota
	Base64
	Hex
)

func (Encoding) Available

func (e Encoding) Available() bool

Available reports whether the given Encoding function is linked into the binary.

func (Encoding) EncodingFunc

func (e Encoding) EncodingFunc() Encoding

func (Encoding) New

func (e Encoding) New() EncodingFunc

New returns a new Encoding.Encoding calculating the given Encoding function. New returns nil if the Encoding function is not linked into the binary.

func (Encoding) String

func (e Encoding) String() string

type EncodingFunc

type EncodingFunc interface {
	EncodeToString(src []byte) string
}