base62

Documentation

Overview

Package base62 implements base62 encoding, fork from https://github.com/yihleego/base62

Index

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

Variables

var InvalidAlphabetError = func() error {
	return fmt.Errorf("base62: invalid alphabet, the alphabet length must be 62")
}

var StdAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

var StdEncoding = NewEncoding(StdAlphabet)

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 {
	Error error
	// contains filtered or unexported fields
}

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

func NewEncoding

func NewEncoding(alphabet 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) Encode

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

Encode encodes src using the encoding enc.