snowflake

Documentation

Index

• Constants
• func MachineID(id uint64) int
• func Sequence(id uint64) uint64
• func Timestamp(id uint64) uint64
• func TimestampABS(id uint64) uint64
• type Snowflake
  • func New(machineID int) (*Snowflake, error)
  • func (s *Snowflake) MachineID() int
  • func (s *Snowflake) NextID() uint64

Constants

const (
	// Epoch indicates the unix epoch time for the current implementation in milliseconds.
	Epoch = 1577836800000 // 2020-01-01 00:00:00.000

	// InvalidID indicates the invalid ID.
	InvalidID = 0
)

Functions

func MachineID

func MachineID(id uint64) int

MachineID returns the machine identifier field in the given ID.

func Sequence

func Sequence(id uint64) uint64

Sequence returns the sequence number field in the given ID.

func Timestamp

func Timestamp(id uint64) uint64

Timestamp returns the timestamp field (Unix timestamp) in milliseconds of the given ID relative to Epoch.

func TimestampABS

func TimestampABS(id uint64) uint64

TimestampABS returns the absolute timestamp field (Unix timestamp) in milliseconds.

Types

type Snowflake

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

Snowflake implements the Twitter Snowflake ID generator.

func New

func New(machineID int) (*Snowflake, error)

New creates an instance of the Snowflake.

func (*Snowflake) MachineID

func (s *Snowflake) MachineID() int

MachineID returns the machine identifier for the Snowflake instance.

func (*Snowflake) NextID

func (s *Snowflake) NextID() uint64

NextID creates a new ID following the Twitter Snowflake specification.