guid

Documentation

Index

• func Init(guidBitsSize int)
• func SizeBits() int
• func SizeBytes() int
• type GUID
  • func MaximumGUID() *GUID
  • func NewGUIDBytes(bytesID []byte) *GUID
  • func NewGUIDInteger(intId int64) *GUID
  • func NewGUIDRandom() *GUID
  • func NewGUIDString(stringID string) *GUID
  • func (guid *GUID) AddOffset(offset string)
  • func (guid *GUID) Bytes() []byte
  • func (guid *GUID) Cmp(guid2 GUID) int
  • func (guid *GUID) Copy() *GUID
  • func (guid *GUID) Equals(guid2 GUID) bool
  • func (guid *GUID) GenerateInnerRandomGUID(topGUID GUID) (*GUID, error)
  • func (guid *GUID) Higher(guid2 GUID) bool
  • func (guid *GUID) Int64() int64
  • func (guid *GUID) Lower(guid2 GUID) bool
  • func (guid *GUID) PercentageOffset(offsetPercentage int, nextGuid GUID) string
  • func (guid *GUID) Short() string
  • func (guid *GUID) String() string
• type Range
  • func NewGUIDRange(lowerGUID GUID, higherGUID GUID) *Range
  • func (gr *Range) CreatePartitions(partitionsPercentage []int) []*Range
  • func (gr *Range) GenerateRandomInside() (*GUID, error)
  • func (gr *Range) HigherGUID() *GUID
  • func (gr *Range) Inside(guid GUID) bool
  • func (gr *Range) LowerGUID() *GUID
  • func (gr *Range) String() string

Functions

func Init

func Init(guidBitsSize int)

Init initializes the GUID package with the size of the GUID.

func SizeBits

func SizeBits() int

SizeBits returns the size of the GUID (in bits).

func SizeBytes

func SizeBytes() int

SizeBytes returns the size of the GUID (in bytes).

Types

type GUID

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

GUID represents a Global Unique Identifier (GUID) for a system's node

func MaximumGUID

func MaximumGUID() *GUID

MaximumGUID creates the maximum available for the current defined number of bits.

func NewGUIDBytes

func NewGUIDBytes(bytesID []byte) *GUID

NewGUIDBytes creates a new GUID based on an array of bytes representation of the identifier. Array of bytes is a representation of the number using the minimum number of bits.

func NewGUIDInteger

func NewGUIDInteger(intId int64) *GUID

NewGUIDInteger creates a new GUID based on an integer64 representation of the identifier.

func NewGUIDRandom

func NewGUIDRandom() *GUID

NewGUIDRandom creates a random GUID in the range [0,MaxGUID).

func NewGUIDString

func NewGUIDString(stringID string) *GUID

NewGUIDString creates a new GUID based on a string representation (in base 10) of the identifier.

func (*GUID) AddOffset

func (guid *GUID) AddOffset(offset string)

AddOffset adds an offset (as a string in base 10) of ids to the GUID.

func (*GUID) Bytes

func (guid *GUID) Bytes() []byte

Bytes returns an array of bytes (with size of guidSizeBits) with the value of the GUID.

func (*GUID) Cmp

func (guid *GUID) Cmp(guid2 GUID) int

Cmp used to check what if the guid is higher, lower or equal than the given guid.

func (*GUID) Copy

func (guid *GUID) Copy() *GUID

Copy creates a copy of the GUID object.

func (*GUID) Equals

func (guid *GUID) Equals(guid2 GUID) bool

Compare if two GUIDs are equal or not.

func (*GUID) GenerateInnerRandomGUID

func (guid *GUID) GenerateInnerRandomGUID(topGUID GUID) (*GUID, error)

GenerateInnerRandomGUID generates a random GUID that belongs to the interval [this, topGUID).

func (*GUID) Higher

func (guid *GUID) Higher(guid2 GUID) bool

Higher returns true if guid is higher than the given guid and false otherwise.

func (*GUID) Int64

func (guid *GUID) Int64() int64

Int64 returns an int64 that represents the GUID.

func (*GUID) Lower

func (guid *GUID) Lower(guid2 GUID) bool

Greater returns true if guid is lower than the given guid and false otherwise.

func (*GUID) PercentageOffset

func (guid *GUID) PercentageOffset(offsetPercentage int, nextGuid GUID) string

PercentageOffset returns the number of ids (as a string with an integer in base 10) using % offset to higher GUID.

func (*GUID) Short

func (guid *GUID) Short() string

Short returns the first digits of the GUID in a string representation

func (*GUID) String

func (guid *GUID) String() string

String returns the value of the GUID in a string representation (as an integer in base 10)

type Range

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

Represents a range of GUIDs i.e. [lowerGUID, higherGUID)

func NewGUIDRange

func NewGUIDRange(lowerGUID GUID, higherGUID GUID) *Range

Creates a new GUID range given a lower GUID and higher GUID.

func (*Range) CreatePartitions

func (gr *Range) CreatePartitions(partitionsPercentage []int) []*Range

Create partitions (set of ranges) of the receiver range.

func (*Range) GenerateRandomInside

func (gr *Range) GenerateRandomInside() (*GUID, error)

Generate random GUID inside the range.

func (*Range) HigherGUID

func (gr *Range) HigherGUID() *GUID

Get the higher GUID of the range.

func (*Range) Inside

func (gr *Range) Inside(guid GUID) bool

Verify if the given GUID is inside the range.

func (*Range) LowerGUID

func (gr *Range) LowerGUID() *GUID

Get the lower GUID of the range.

func (*Range) String

func (gr *Range) String() string

Print the range into the log.