id

Documentation

Index

• type ID
  • func GenerateID() ID
  • func ParseID(s string) (ID, error)
  • func (id ID) MarshalJSON() ([]byte, error)
  • func (id ID) String() string
  • func (id *ID) UnmarshalJSON(data []byte) error
• type UUID
  • func FromStr(s string) (id UUID, err error)
  • func MustFromStr(s string) UUID
  • func Rand() UUID
  • func (this UUID) Hex() string

Types

type ID

type ID uint64

An ID is a unique, uniformly distributed 64-bit ID.

func GenerateID

func GenerateID() ID

generateID returns a randomly-generated 64-bit ID. This function is thread-safe. IDs are produced by consuming an AES-CTR-128 keystream in 64-bit chunks. The AES key is randomly generated on initialization, as is the counter's initial state. On machines with AES-NI support, ID generation takes ~30ns and generates no garbage.

func ParseID

func ParseID(s string) (ID, error)

ParseID parses the given string as a hexadecimal string.

func (ID) MarshalJSON

func (id ID) MarshalJSON() ([]byte, error)

MarshalJSON encodes the ID as a hex string.

func (ID) String

func (id ID) String() string

String returns the ID as a hex string.

func (*ID) UnmarshalJSON

func (id *ID) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the given data as either a hexadecimal string or JSON integer.

type UUID

type UUID [16]byte

UUID type.

func FromStr

func FromStr(s string) (id UUID, err error)

FromStr returns a UUID based on a string. The string could be in the following format:

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}

If the string is not in one of these formats, it'll return an error.

func MustFromStr

func MustFromStr(s string) UUID

MustFromStr behaves similarly to FromStr except that it'll panic instead of returning an error.

func Rand

func Rand() UUID

Rand generates a new version 4 UUID.

func (UUID) Hex

func (this UUID) Hex() string

Hex returns a hex string representation of the UUID in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.