README
¶
go-uuid
A package providing UUID v1, v4 and OrderedUUID with utility interface and function.
What is an OrderedUUID?
It is a UUID v1 where the timestamp is positioned at the first part of the uuid. It is useful as a primary key or index in a database like MySQL. This way, it can be sorted by timestamp, and new elements should be added on top of the index.
Utility function?
Yes, the UUID struct has a Scan/Value function that follows the driver.Valuer / driver.Scanner interface.
This allows you to scan your struct with a UUID right from the database!
Moreover, it is implementing the encoding.TextUnmarshaler and the encoding.TextMarshaler for encoding and decoding features.
Supported UUID formats for decoding
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
"6ba7b8109dad11d180b400c04fd430c8"
Supported UUID text representations
uuid := canonical | hashlike
plain := canonical | hashlike
canonical := 4hexoct '-' 2hexoct '-' 2hexoct '-' 6hexoct
hashlike := 12hexoct
Documentation
¶
Index ¶
Constants ¶
const UUIDSize = 16
UUIDSize is the size of the uuid
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type UUID ¶
OrderedUUID is an UUIDv1 with some bit shifted for database index performance
func FromString ¶
FromString returns an OrderedUUID parsed from string input. Input is expected in a form accepted by UnmarshalText.
func FromUUIDv1 ¶
func FromUUIDv1(uuid uuid.UUID) UUID
FromUUIDv1 populates Byte from uuidV1 and converts it
func NewOrdered ¶
func NewOrdered() UUID
NewOrdered creates a new UUIDv1 and converts it to an OrderedUUID
v1 UUID: aaaabbbb-cccc-dddd-1234-567890123456 transposed: ddddcccc-aaaa-bbbb-1234-567890123456
func (UUID) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface. The encoding is the same as returned by String.
func (*UUID) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface. Following formats are supported:
"6ba7b810-9dad-11d1-80b4-00c04fd430c8", "6ba7b8109dad11d180b400c04fd430c8"
Supported UUID text representation follows:
uuid := canonical | hashlike plain := canonical | hashlike canonical := 4hexoct '-' 2hexoct '-' 2hexoct '-' 6hexoct hashlike := 12hexoct
Source Files