foxid

README

FOxID

A Go implementation of FOxID created by: Kasefuchs

Documentation

Index

• Variables
• type Builder
• type FOxID
  • func Empty() (id FOxID)
  • func Generate(builder Builder) (id FOxID)
  • func Parse(s string) (id *FOxID, err error)
  • func (id *FOxID) Bytes() []byte
  • func (id *FOxID) Counter() uint32
  • func (id *FOxID) Datacenter() uint16
  • func (id *FOxID) GenerateRandom()
  • func (id *FOxID) Generator() uint32
  • func (id *FOxID) IncrementCounter()
  • func (id *FOxID) Random() uint32
  • func (id *FOxID) SetCounter(value uint32)
  • func (id *FOxID) SetDatacenter(value uint16)
  • func (id *FOxID) SetGenerator(value uint32)
  • func (id *FOxID) SetRandom(value uint32)
  • func (id *FOxID) SetTime(t time.Time)
  • func (id *FOxID) SetTimestamp(timestamp uint64)
  • func (id *FOxID) SetWorker(value uint16)
  • func (id *FOxID) String() string
  • func (id *FOxID) Time() time.Time
  • func (id *FOxID) Timestamp() uint64
  • func (id *FOxID) Worker() uint16

Variables

var ErrInvalidFOxID = errors.New("invalid FOxID")

Types

type Builder

type Builder struct {
	Time       time.Time
	Generator  uint32
	Datacenter uint16
	Worker     uint16
	Counter    uint32
	Random     uint32
}

type FOxID

type FOxID [16]byte

FOxID is a unique identifier with lexicographic sorting capabilities.

func Empty

func Empty() (id FOxID)

Empty returns the new empty FOxID.

func Generate

func Generate(builder Builder) (id FOxID)

Generate returns the new generated FOxID.

func Parse

func Parse(s string) (id *FOxID, err error)

Parse parses FOxID from its string representation.

func (*FOxID) Bytes

func (id *FOxID) Bytes() []byte

Bytes returns a bytes slice representation of FOxID.

func (*FOxID) Counter

func (id *FOxID) Counter() uint32

Counter returns the number of generated ids encoded in the FOxID.

func (*FOxID) Datacenter

func (id *FOxID) Datacenter() uint16

Datacenter returns the datacenter id encoded in the FOxID.

func (*FOxID) GenerateRandom

func (id *FOxID) GenerateRandom()

GenerateRandom sets the random component of FOxID to random value.

func (*FOxID) Generator

func (id *FOxID) Generator() uint32

Generator returns the generator id encoded in the FOxID.

func (*FOxID) IncrementCounter

func (id *FOxID) IncrementCounter()

IncrementCounter sets the FOxID counter component to the global incrementing counter.

func (*FOxID) Random

func (id *FOxID) Random() uint32

Random returns the random value used to create the FOxID.

func (*FOxID) SetCounter

func (id *FOxID) SetCounter(value uint32)

SetCounter sets the counter component of FOxID to the given value.

func (*FOxID) SetDatacenter

func (id *FOxID) SetDatacenter(value uint16)

SetDatacenter sets the datacenter component of FOxID to the given value.

func (*FOxID) SetGenerator

func (id *FOxID) SetGenerator(value uint32)

SetGenerator sets the generator component of FOxID to the given value.

func (*FOxID) SetRandom

func (id *FOxID) SetRandom(value uint32)

SetRandom sets the random component of FOxID to the given value.

func (*FOxID) SetTime

func (id *FOxID) SetTime(t time.Time)

SetTime sets the time component of the FOxID to the given in time.Time amount of milliseconds since Unix epoch.

func (*FOxID) SetTimestamp

func (id *FOxID) SetTimestamp(timestamp uint64)

SetTimestamp sets the timestamp component to the given amount of milliseconds since Unix epoch.

func (*FOxID) SetWorker

func (id *FOxID) SetWorker(value uint16)

SetWorker sets the worker component of FOxID to the given value.

func (*FOxID) String

func (id *FOxID) String() string

String returns a lexicographically sortable string encoded FOxID.

func (*FOxID) Time

func (id *FOxID) Time() time.Time

Time returns the timestamp component encoded in the FOxID as time.Time.

func (*FOxID) Timestamp

func (id *FOxID) Timestamp() uint64

Timestamp returns the timestamp encoded in the FOxID.

func (*FOxID) Worker

func (id *FOxID) Worker() uint16

Worker returns the worker id encoded in the FOxID.