shortid

Documentation

Index

• type Base58
  • func NewBase58Service() *Base58
  • func (b *Base58) Decode(input string) (entities.ID, error)
  • func (b *Base58) Encode(input entities.ID) string
• type Fake
  • func NewFakeService() *Fake
  • func (f *Fake) Decode(input string) (entities.ID, error)
  • func (f *Fake) Encode(input entities.ID) string
• type Service

Types

type Base58

type Base58 struct{}

Base58 shortens ID using a Flickr base58 encoding

func NewBase58Service

func NewBase58Service() *Base58

NewBase58Service creates a new base58 short ID service

func (*Base58) Decode

func (b *Base58) Decode(input string) (entities.ID, error)

Decode converts a short ID to an UUID

func (*Base58) Encode

func (b *Base58) Encode(input entities.ID) string

Encode converts an UUID to a short ID

type Fake

type Fake struct{}

Fake returns the input unchanged

func NewFakeService

func NewFakeService() *Fake

NewFakeService creates a new fake short ID service

func (*Fake) Decode

func (f *Fake) Decode(input string) (entities.ID, error)

Decode converts a short ID to an UUID

func (*Fake) Encode

func (f *Fake) Encode(input entities.ID) string

Encode converts an UUID to a short ID

type Service

type Service interface {
	// Encode converts an UUID to a short ID
	Encode(input entities.ID) string

	// Decode converts a short ID to an UUID
	Decode(input string) (entities.ID, error)
}

Service interface