wuid

Documentation

Overview

Example

newClient := func() (*mongo.Client, bool, error) {
	var client *mongo.Client
	// ...
	return client, true, nil
}

// Setup
g := NewWUID("default", nil)
_ = g.LoadH28FromMongo(newClient, "test", "wuid", "default")

// Generate
for i := 0; i < 10; i++ {
	fmt.Printf("%#016x\n", g.Next())
}

Index

• type NewClient
• type Option
  • func WithH28Verifier(cb func(h28 int64) error) Option
  • func WithSection(section int8) Option
  • func WithStep(step int64, floor int64) Option
• type WUID
  • func NewWUID(name string, opts ...Option) *WUID
  • func (this *WUID) LoadH28FromMongo(newClient NewClient, dbName, coll, docID string) error
  • func (this *WUID) Next() int64
  • func (this *WUID) RenewNow() error

Examples

• Package

Types

type NewClient

type NewClient func() (client *mongo.Client, autoDisconnect bool, err error)

type Option

type Option = v2.Option

func WithH28Verifier

func WithH28Verifier(cb func(h28 int64) error) Option

WithH28Verifier sets your own h28 verifier

func WithSection

func WithSection(section int8) Option

WithSection adds a section ID to the generated numbers. The section ID must be in between [0, 7].

func WithStep

func WithStep(step int64, floor int64) Option

WithStep sets the step and floor of Next()

type WUID

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

WUID is an extremely fast unique number generator.

func NewWUID

func NewWUID(name string, opts ...Option) *WUID

NewWUID creates a new WUID instance.

func (*WUID) LoadH28FromMongo

func (this *WUID) LoadH28FromMongo(newClient NewClient, dbName, coll, docID string) error

LoadH28FromMongo adds 1 to a specific number in your MongoDB, fetches its new value, and then sets that as the high 28 bits of the unique numbers that Next generates.

func (*WUID) Next

func (this *WUID) Next() int64

Next returns the next unique number.

func (*WUID) RenewNow

func (this *WUID) RenewNow() error

RenewNow reacquires the high 28 bits from your data store immediately