snowflake

Documentation

Overview

Package snowflake provides a unique ID generation based on Twitter Snowflake algorithm.

Index

• type Settings
• type Snowflake
  • func New(s Settings) *Snowflake
  • func (s Snowflake) Gen() string
  • func (s Snowflake) Name() string
  • func (s Snowflake) Size() int
  • func (s Snowflake) Validate(id string) bool

Types

type Settings

type Settings struct {
	Node int64
}

type Snowflake

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

Snowflake represents a Snowflake generator with a unique generator.

func New

func New(s Settings) *Snowflake

New creates a new Snowflake generator with a unique generator.

func (Snowflake) Gen

func (s Snowflake) Gen() string

Gen generates a new Snowflake ID as a string.

func (Snowflake) Name

func (s Snowflake) Name() string

Name returns the name of the generator.

func (Snowflake) Size

func (s Snowflake) Size() int

Size returns the bit size of the generated Snowflake ID.

func (Snowflake) Validate

func (s Snowflake) Validate(id string) bool

Validate checks if the provided ID is a valid Snowflake ID.