snowflakeid

package module

v1.0.1 Latest Latest Go to latest Published: Feb 20, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

A distributed unique ID generator inspired by Twitter's Snowflake.

This section is empty.

View Source

var (
	InvalidSystemClock = errors.New("invalid system clock")
)

This section is empty.

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

func NewSnowflake(workerID uint32) (*Snowflake, error)

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

func (sf *Snowflake) WorkerID() uint32

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

func NewSnowflakeFactory(bitLenWorkerID, bitLenSequence, gapMs uint, startTime time.Time) *SnowflakeFactory

func (f *SnowflakeFactory) BuildID(workerID uint32, elapsedTime uint64, sequence uint32) (uint64, error)

func (f *SnowflakeFactory) CurrentElapsedTime() uint64

func (f *SnowflakeFactory) FlakeTimestamp(t time.Time) uint64

func (f *SnowflakeFactory) MaskSequence(sequence uint32) uint32

func (f *SnowflakeFactory) MaxSequence() uint32

func (f *SnowflakeFactory) MaxTime() time.Time

func (f *SnowflakeFactory) MaxWorkerID() uint32

func (f *SnowflakeFactory) NewSnowflake(workerID uint32) (*Snowflake, error)

func (f *SnowflakeFactory) SleepTime(overtime time.Duration) time.Duration

Path	Synopsis
workeridutil