uuid

Documentation

Overview

This uuid package implements UUIDv7¹ with additional convenience methods.

¹ https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html#name-uuid-version-7

Index

• Constants
• type ID
  • func (id ID) String() string
• type UUID
  • func MustParse(uuid string) UUID
  • func New() (UUID, error)
  • func Now() UUID
  • func Parse(uuid string) (UUID, error)
  • func (uuid UUID) After(other UUID) bool
  • func (uuid UUID) Before(other UUID) bool
  • func (uuid UUID) Bytes() []byte
  • func (uuid UUID) Date() time.Time
  • func (uuid UUID) Id() ID
  • func (uuid UUID) IsMax() bool
  • func (uuid UUID) IsNil() bool
  • func (uuid UUID) IsValid() bool
  • func (uuid UUID) String() string
  • func (uuid UUID) Version() Version
• type UUIDs
  • func (u UUIDs) Len() int
  • func (u UUIDs) Less(i, j int) bool
  • func (u UUIDs) Swap(i, j int)
• type Version

Constants

const (
	UUIDv7 = Version(7)
)

Types

type ID

type ID [6]byte

Last 48 bits of random part.

func (ID) String

func (id ID) String() string

String returns the ID string.

type UUID

type UUID [size]byte

Representation of an UUID version 7.

var (
	// 00000000-0000-0000-0000-000000000000
	Nil UUID = [size]byte{}
	// FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF
	Max UUID = [size]byte{255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255}
)

func MustParse

func MustParse(uuid string) UUID

MustParse takes an UUID as string and returns an UUID type or panic.

func New

func New() (UUID, error)

New generates an UUIDv7 and nil return or a Nil UUID and an error message.

func Now

func Now() UUID

Now generates an UUIDv7 like New() or panics on error.

func Parse

func Parse(uuid string) (UUID, error)

Parse takes an UUID as string and returns an UUIDv7 or Nil with an error.

func (UUID) After

func (uuid UUID) After(other UUID) bool

After compares the creation dates of uuid with other.

func (UUID) Before

func (uuid UUID) Before(other UUID) bool

Before compares the creation dates of uuid with other.

func (UUID) Bytes

func (uuid UUID) Bytes() []byte

Bytes returns the 16 raw bytes of the UUIDv7 as []byte.

func (UUID) Date

func (uuid UUID) Date() time.Time

Date returns the date of UUIDv7 creation.

func (UUID) Id

func (uuid UUID) Id() ID

Id() returns the random non-unique ID from the UUIDv7.

func (UUID) IsMax

func (uuid UUID) IsMax() bool

IsMax() compares given UUIDv7 against Max.

func (UUID) IsNil

func (uuid UUID) IsNil() bool

IsNil() compares given UUIDv7 against Nil.

func (UUID) IsValid

func (uuid UUID) IsValid() bool

IsValid checks if the UUID is a valid UUIDv7.

func (UUID) String

func (uuid UUID) String() string

String returns the UUIDv7 string with dash separators.

func (UUID) Version

func (uuid UUID) Version() Version

Version returns the version. Usually see constant UUIDv7.

type UUIDs

type UUIDs []UUID

UUIDs is a collection of UUIDv7 that implements the sort interface.

func (UUIDs) Len

func (u UUIDs) Len() int

func (UUIDs) Less

func (u UUIDs) Less(i, j int) bool

func (UUIDs) Swap

func (u UUIDs) Swap(i, j int)

type Version

type Version byte

A Version represents a UUID's version.