snowflake

Documentation

Overview

Package snowflake ...

Index

• Constants
• Variables
• type Snowflake
  • func New() Snowflake
  • func NewAtTime(t time.Time) Snowflake
  • func Parse(snowflake string) Snowflake
  • func (s Snowflake) MarshalJSON() ([]byte, error)
  • func (s Snowflake) String() string
  • func (s Snowflake) Time() time.Time
  • func (s *Snowflake) UnmarshalJSON(v []byte) error
  • func (s Snowflake) Valid() bool

Constants

const (

	// Nil is a nil/null snowflake.
	Nil = ^Snowflake(0)
)

Variables

var (
	NodeID = 1
)

Types

type Snowflake

type Snowflake uint64

Snowflake represents a snowflake.

Timestamp - 63 to 22 (42 bits) Node ID - 21 to 12 (10 bits) Increment - 11 to 0 (12 bits)

func New

func New() Snowflake

New returns a new snowflake.

func NewAtTime

func NewAtTime(t time.Time) Snowflake

NewAtTime returns a new snowflake using the specified time.

func Parse

func Parse(snowflake string) Snowflake

Parse parses a string into a snowflake.

func (Snowflake) MarshalJSON

func (s Snowflake) MarshalJSON() ([]byte, error)

MarshalJSON satisfies json.Marshaler.

func (Snowflake) String

func (s Snowflake) String() string

String satisfies fmt.Stringer.

func (Snowflake) Time

func (s Snowflake) Time() time.Time

Time returns the time at which the snowflake was generated at.

func (*Snowflake) UnmarshalJSON

func (s *Snowflake) UnmarshalJSON(v []byte) error

UnmarshalJSON satisfies json.Unmarshaler.

func (Snowflake) Valid

func (s Snowflake) Valid() bool

Valid returns true if the snowflake is valid.