snowflake

Documentation

Index

• Variables
• type Snowflake
  • func New(workerId uint32) (*Snowflake, error)
  • func (sf *Snowflake) Mint() (string, error)
  • func (sf *Snowflake) MintID() (uint64, error)

Variables

var (
	ErrInvalidWorkerId  error = errors.New("Invalid worker ID - worker ID out of range")
	ErrOverflow         error = errors.New("Timestamp overflow (past end of lifespan) - unable to generate any more IDs")
	ErrSequenceOverflow error = errors.New("Sequence overflow (too many IDs generated) - unable to generate IDs for 1 millisecond")
)

Types

type Snowflake

type Snowflake struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func New

func New(workerId uint32) (*Snowflake, error)

New creates a new instance of a snowflake compatible ID minter the worker ID must be unique otherwise ID collisions are likely to occur

func (*Snowflake) Mint

func (sf *Snowflake) Mint() (string, error)

func (*Snowflake) MintID

func (sf *Snowflake) MintID() (uint64, error)

Mint a new 64bit ID based on the current time, worker id and sequence