sdrapkin/guid: Fast cryptographically safe Guid generator for Go

Fast cryptographically safe Guid generator for Go. By Stan Drapkin.

Go playground

package main

import (
	"fmt"

	"github.com/sdrapkin/guid"
)

func main() {
	for range 4 {
		fmt.Printf("%x\n", guid.New())
	}
	fmt.Println()
	for range 4 {
		g := guid.New()
		fmt.Println(&g) // calls g.String()
	}
}

79c9779af20dcd21fbe60f3b336ed08c
da2026d38edca4371a476efd41333d23
88c3033b002b0e73321509ef26de607f
a84e961ff7f09f5210ea04585f152e73

WF8MvK5CUOrI-enEuvS0jw
AOp8Voi5knpu1mg3RjzmSg
gxOQRIVR4B_uGHD6OP76XA
Zo_hpnDxkOsAWLk1tIS6DA

Guid is ~10x faster than `github.com/google/uuid`

guid.New() is 6~10 ns
guid.NewString() is 40~60 ns
String() on existing guid is ~40 ns
multi-goroutine calls do not increase per-call latency
if your library is faster – please let me know!

Function	Description
`guid.New()`	Generate a new Guid
`guid.NewString()`	Generate a new Guid as Base64Url string
`guid.Parse(s)`	Parse Base64Url string to Guid
`guid.ParseBytes(b)`	Parse Base64Url bytes to Guid
`guid.FromBytes(b)`	Parse 16-byte slice to Guid
`guid.Nil`	The zero-value Guid

go test -bench=.* -benchtime=4s
goos: windows
goarch: amd64
pkg: github.com/sdrapkin/guid
cpu: Intel(R) Core(TM) i7-10510U CPU @ 1.80GHz

Benchmarks guid [10 calls]	Time/op	Bytes/op	Allocs/op
guid_New_x10-8	203.4 ns/op	0 B/op	0 allocs/op
guid_NewString_x10-8	582.4 ns/op	240 B/op	10 allocs/op
guid_String_x10-8	388.9 ns/op	240 B/op	10 allocs/op
guid_New_Parallel_x10-8	62.45 ns/op	0 B/op	0 allocs/op
guid_NewString_Parallel_x10-8	374.2 ns/op	240 B/op	10 allocs/op

Alternative library benchmarks:

Benchmarks nanoid [10 calls]	Time/op	Bytes/op	Allocs/op
nanoid_New_x10-8	2493 ns/op	240 B/op	10 allocs/op
nanoid_New_Parallel_x10-8	1282 ns/op	240 B/op	10 allocs/op

Benchmarks uuid [10 calls]	Time/op	Bytes/op	Allocs/op
uuid_New_x10-8	2216 ns/op	160 B/op	10 allocs/op
uuid_New_RandPool_x10-8	528.2 ns/op	0 B/op	0 allocs/op
uuid_New_Parallel_x10-8	1064 ns/op	160 B/op	10 allocs/op
uuid_New_RandPool_Parallel_x10-8	1301 ns/op	0 B/op	0 allocs/op

Benchmarks [20 guid encodings]	Time/op	Bytes/op	Allocs/op
guid_ToBase64UrlString-8	1025 ns/op	480 B/op	20 allocs/op
base64_RawURLEncoding_EncodeToString-8	1867 ns/op	960 B/op	40 allocs/op
guid_EncodeBase64URL-8	392.0 ns/op	0 B/op	0 allocs/op
base64_RawURLEncoding_Encode-8	463.4 ns/op	0 B/op	0 allocs/op

Go Reference

Full go doc style documentation:

To install the guid package, run the following command:

go get -u github.com/sdrapkin/guid

To use the guid package in your Go project, import it as follows:

import "github.com/sdrapkin/guid"

Guid supports JSON marshalling and unmarshalling for both value and pointer types:

Value fields serialize as 22-character Base64Url strings.
Pointer fields serialize as strings or null (for nil pointers).
Zero-value GUIDs (guid.Nil) are handled correctly.

Example: JSON Marshalling

type User struct {
	ID        guid.Guid  `json:"id"`
	ManagerID *guid.Guid `json:"mid"`
}

u, u2 := User{ID: guid.New()}, User{}
data, _ := json.Marshal(u)
fmt.Println(string(data)) // {"id":"tI0EMdDXpOcvvGLktob4Ug","mid":null}

_ = json.Unmarshal(data, &u2)
fmt.Println(u2.ID == u.ID) // true

Fast cryptographically safe Guid generator for Go. By Stan Drapkin.

Guid is ~10x faster than github.com/google/uuid

Alternative library benchmarks:

Example: JSON Marshalling

Leave a Comment Cancel Reply

Guid is ~10x faster than `github.com/google/uuid`