uuid

Documentation

Overview

Package uuid can be used to generate and parse universally unique identifiers, a standardized format in the form of a 128 bit number.

http://tools.ietf.org/html/rfc4122

Index

• Constants
• type UUID
  • func FromBytes(input []byte) UUID
  • func NewRandom() UUID
  • func NewTime() UUID
  • func Parse(input string) (UUID, error)
  • func (u UUID) Bytes() []byte
  • func (u UUID) Node() []byte
  • func (u UUID) String() string
  • func (u UUID) Time() time.Time
  • func (u UUID) Timestamp() uint64
  • func (u UUID) Variant() int
  • func (u UUID) Version() int

Constants

const (
	VariantNCSCompat = 0
	VariantIETF      = 2
	VariantMicrosoft = 6
	VariantFuture    = 7
)

Types

type UUID

type UUID [16]byte

func FromBytes

func FromBytes(input []byte) UUID

FromBytes converts a raw byte slice to an UUID. It will panic if the slice isn't exactly 16 bytes long.

func NewRandom

func NewRandom() UUID

NewRandom generates a totally random UUID (version 4) as described in RFC 4122.

func NewTime

func NewTime() UUID

NewTime generates a new time based UUID (version 1) as described in RFC 4122. This UUID contains the MAC address of the node that generated the UUID, a timestamp and a sequence number.

func Parse

func Parse(input string) (UUID, error)

Parse parses a 32 digit hexadecimal number (that might contain hyphens) representing an UUID.

func (UUID) Bytes

func (u UUID) Bytes() []byte

Bytes returns the raw byte slice for this UUID. A UUID is always 128 bits (16 bytes) long.

func (UUID) Node

func (u UUID) Node() []byte

Node extracts the MAC address of the node who generated this UUID. It will return nil if the UUID is not a time based UUID (version 1).

func (UUID) String

func (u UUID) String() string

String returns the UUID in it's canonical form, a 32 digit hexadecimal number in the form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

func (UUID) Time

func (u UUID) Time() time.Time

Time is like Timestamp, except that it returns a time.Time.

func (UUID) Timestamp

func (u UUID) Timestamp() uint64

Timestamp extracts the timestamp information from a time based UUID (version 1).

func (UUID) Variant

func (u UUID) Variant() int

Variant returns the variant of this UUID. This package will only generate UUIDs in the IETF variant.

func (UUID) Version

func (u UUID) Version() int

Version extracts the version of this UUID variant. The RFC 4122 describes five kinds of UUIDs.