Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flexstack/uuid
Faster, more flexible v4 and v7 UUIDs in Go
https://github.com/flexstack/uuid
go-uuid uuid uuid-generator uuid-go uuid-parser uuid-v4 uuid-v7 uuid4 uuid7 uuidv4 uuidv7
Last synced: about 1 month ago
JSON representation
Faster, more flexible v4 and v7 UUIDs in Go
- Host: GitHub
- URL: https://github.com/flexstack/uuid
- Owner: flexstack
- License: mit
- Created: 2024-05-17T17:04:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-17T18:12:39.000Z (7 months ago)
- Last Synced: 2024-06-19T15:15:01.789Z (6 months ago)
- Topics: go-uuid, uuid, uuid-generator, uuid-go, uuid-parser, uuid-v4, uuid-v7, uuid4, uuid7, uuidv4, uuidv7
- Language: Go
- Homepage: https://pkg.go.dev/github.com/flexstack/uuid
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# uuid
Faster, more flexible v4 and v7 UUIDs in Go
## Features
- [x] Generate and parse v4 and v7 UUIDs
- [x] Canonical, hash, and base58 encoding
- [x] Select a default string format (i.e. base58, hash, canonical)
- [x] SQL scanning and JSON marshaling
- [x] The fastest UUID parsing available in Golang
## Installation
```bash
go get github.com/flexstack/uuid
```
## Usage
```go
import "github.com/flexstack/uuid"
// Optionally set a default format
uuid.DefaultFormat = uuid.FormatBase58
// Generate a new v4 UUID
u := uuid.Must(uuid.NewV4())
// Generate a new v7 UUID
u := uuid.Must(uuid.NewV7())
// Parse a UUID
u, err := uuid.FromString("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
// Parse a UUID from a byte slice
u, err := uuid.FromBytes([]byte{0x6b, 0xa7, 0xb8, 0x10, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8})
// Format a UUID
asHash := u.Format(uuid.FormatHash)
asBase58 := u.Format(uuid.FormatBase58)
asCanonical := u.Format(uuid.FormatCanonical)
// Scan a SQL UUID
var u uuid.UUID
err := db.QueryRow("SELECT id FROM users WHERE email = $1", email).Scan(&u)
if u.IsNil() {
// Handle nil UUID
}
```
## Setting a default format
Changing the default format will affect how UUIDs are marshaled to strings from `MarshalText`, and `MarshalJSON`.
```go
import (
"encoding/json"
"fmt"
"github.com/flexstack/uuid"
)
func main() {
uuid.DefaultFormat = uuid.FormatBase58
u := uuid.FromStringOrNil("ffffffff-ffff-ffff-ffff-ffffffffffff")
// Marshal to base58
m := map[string]uuid.UUID{"id": u}
b, _ := json.Marshal(m)
fmt.Println(string(b)) // {"id": "YcVfxkQb6JRzqk5kF2tNLv"}
}
```
## Credit
This package is a fork of [github.com/gofrs/uuid](https://github.com/gofrs/uuid) with the following changes:
- 2x improvement to `FromString`, `UnmarshalText`, and `UnmarshalJSON` performance
- Adds base58 encoding.
- Allows people to set a default format (i.e. base58, hash, canonical)
- Scans nil UUIDs from SQL databases as nil UUIDs (00000000-0000-0000-0000-000000000000) instead of `nil`.
- Fixes issue with [TimestampFromV7](https://github.com/gofrs/uuid/issues/128) not being spec compliant.
- Removed v1, v3, v5 UUIDs.
- Removed support for braced and URN string formats.
## Benchmarks
MacBook Air (15-inch, M2, 2023) Apple M2, 24GB RAM, MacOS 14.4.1
### Format()
```
Format(FormatCanonical) 44625793 26.54 ns/op 48 B/op 1 allocs/op
Format(FormatHash) 44022964 26.85 ns/op 32 B/op 1 allocs/op
Format(FormatBase58) 5350190 224.0 ns/op 24 B/op 1 allocs/op
```
### FromString()
```
FromString(FormatCanonical) 70893008 16.88 ns/op 0 B/op 0 allocs/op
FromString(FormatBase58) 16760137 71.77 ns/op 0 B/op 0 allocs/op
```
### NewVx()
```
NewV4() 2961621 401.6 ns/op 16 B/op 1 allocs/op
NewV7() 3859464 308.7 ns/op 16 B/op 1 allocs/op
```
## Contributing
Read the [CONTRIBUTING.md](CONTRIBUTING.md) guide to learn how to contribute to this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.