base62

Documentation

Index

• Constants
• type Error
  • func (e Error) Error() string
• type Token
  • func Decode(token string) (Token, error)
  • func New(tokenLength ...int) Token
  • func (t Token) Encode() string
  • func (t Token) MarshalText() ([]byte, error)
  • func (t *Token) UnmarshalText(data []byte) error

Constants

const (
	// Base62 is a string respresentation of every possible base62 character
	Base62 = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

	// MaxTokenLength is the largest possible character length of a token
	MaxTokenLength = 10

	// MinTokenLength is the smallest possible character length of a token
	MinTokenLength = 1

	// DefaultTokenLength is the default size of a token
	DefaultTokenLength = 8
)

const (
	// ErrTokenTooSmall is the error returned or panic'd when a base62 token is smaller than `MinTokenLength`
	ErrTokenTooSmall = Error("the base62 token is smaller than MinTokenLength")

	// ErrTokenTooBig is the error returned or panic'd when a base62 token is larger than `MaxTokenLength`
	ErrTokenTooBig = Error("the base62 token is larger than MaxTokenLength")

	// ErrInvalidCharacter is the error returned or panic'd when a non `Base62` string is being parsed
	ErrInvalidCharacter = Error("there was a non base62 character in the token")
)

Types

type Error

type Error string

Error is a token error

func (Error) Error

func (e Error) Error() string

Error implements the `errors.Error` interface

type Token

type Token uint64

Token is an alias of an uint64 that is marshalled into a base62 encoded token

func Decode

func Decode(token string) (Token, error)

Decode returns a token from a 1-12 character base62 encoded string

func New

func New(tokenLength ...int) Token

New returns a `Base62` encoded `Token` of *up to* `DefaultTokenLength` if you pass in a `tokenLength` between `MinTokenLength` and `MaxTokenLength` this will return a `Token` of *up to* that length instead if you pass in a `tokenLength` that is out of range it will panic

func (Token) Encode

func (t Token) Encode() string

Encode encodes the token into a base62 string

func (Token) MarshalText

func (t Token) MarshalText() ([]byte, error)

MarshalText implements the `encoding.TextMarsheler` interface

func (*Token) UnmarshalText

func (t *Token) UnmarshalText(data []byte) error

UnmarshalText implements the `encoding.TextUnmarshaler` interface