shortid

Documentation

Index

• type Setting
• type ShortID
  • func New(ss ...*Setting) *ShortID
  • func (s ShortID) Gen() string
  • func (s ShortID) Name() string
  • func (s ShortID) Size() int
  • func (s ShortID) Validate(id string) bool

Types

type Setting

type Setting struct {
	Worker   uint8
	Alphabet string
	Seed     uint64
}

type ShortID

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

func New

func New(ss ...*Setting) *ShortID

New creates a new ShortID generator with a unique node.

func (ShortID) Gen

func (s ShortID) Gen() string

Gen generates a new ShortID ID as a string.

func (ShortID) Name

func (s ShortID) Name() string

Name returns the name of the generator.

func (ShortID) Size

func (s ShortID) Size() int

Size returns the bit size of the generated ShortID ID.

func (ShortID) Validate

func (s ShortID) Validate(id string) bool

Validate checks if the provided ID is a valid ShortID ID.