id

Documentation

Index

• Constants
• Variables
• func A20RID(prefix Prefix) string
• func JournalID() string
• type Generator
  • func NewGenerator(sequence Sequence) Generator
• type Prefix
  • func (p Prefix) String() string
• type Sequence

Constants

const (

	// MaxSequence maximum allowed value
	MaxSequence uint32 = math.MaxUint32 >> 4 // 268435455
)

Variables

var ErrSequenceOverflow = fmt.Errorf("sequence over the max limition of %d", MaxSequence)

ErrSequenceOverflow oveflow error

Functions

func A20RID

func A20RID(prefix Prefix) string

A20RID a 18len decimal random id with 2len prefix

func JournalID

func JournalID() string

JournalID a minami58 encoded random string

Types

type Generator

type Generator interface {
	New(prefix Prefix) (string, error)
	Parse(id string) (Prefix, time.Time, error)
}

Generator genarate a 18len decimal id with 2len prefix

func NewGenerator

func NewGenerator(sequence Sequence) Generator

NewGenerator create a new generator

type Prefix

type Prefix [2]byte

Prefix two visible ASCII

func (Prefix) String

func (p Prefix) String() string

type Sequence

type Sequence interface {
	Next() (uint32, error)
}

Sequence number generator