base62

Documentation

Index

• Variables
• type CorruptInputError
  • func (e CorruptInputError) Error() string
• type Encoding
  • func NewEncoding(encoder string) *Encoding
  • func (enc *Encoding) Decode(src []byte) ([]byte, error)
  • func (enc *Encoding) DecodeString(s string) ([]byte, error)
  • func (enc *Encoding) Encode(src []byte) []byte
  • func (enc *Encoding) EncodeToString(src []byte) string

Variables

var StdEncoding = NewEncoding(encodeStd)

StdEncoding is the standard base62 encoding.

Types

type CorruptInputError

type CorruptInputError int64

func (CorruptInputError) Error

func (e CorruptInputError) Error() string

type Encoding

type Encoding struct {
	// contains filtered or unexported fields
}

An Encoding is a radix 62 encoding/decoding scheme, defined by a 62-character alphabet.

func NewEncoding

func NewEncoding(encoder string) *Encoding

NewEncoding returns a new padded Encoding defined by the given alphabet, which must be a 62-byte string that does not contain the padding character or CR / LF ('\r', '\n').

func (*Encoding) Decode

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

Decode decodes src using the encoding enc. If src contains invalid base62 data, it will return the number of bytes successfully written and CorruptInputError. New line characters (\r and \n) are ignored.

func (*Encoding) DecodeString

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

DecodeString returns the bytes represented by the base62 string s.

func (*Encoding) Encode

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

Encode encodes src using the encoding enc.

func (*Encoding) EncodeToString

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

EncodeToString returns the base62 encoding of src.