GoUUID

https://pkg.go.dev/github.com/nu7hatch/gouuid
Admin
GoUUID is a pure Go UUID implementation providing immutable UUID structs and functions for...
Tokens:929
Snippets:18
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install gouuid package

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Use the go tool to install the package.

```bash
$ go get github.com/nu7hatch/gouuid
```

--------------------------------

### Get UUID version

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Returns the algorithm version number used to generate the UUID.

```go
func (u *UUID) Version() uint
```

--------------------------------

### Get UUID string representation

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Returns the unparsed string version of the UUID.

```go
func (u *UUID) String() string
```

--------------------------------

### Get UUID variant

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Returns the internal layout variant of the UUID.

```go
func (u *UUID) Variant() byte
```

--------------------------------

### Define standard namespace UUIDs

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Standard namespace UUIDs used for generating version 3 or 5 UUIDs.

```go
var (
	NamespaceDNS, _  = ParseHex("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
	NamespaceURL, _  = ParseHex("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
	NamespaceOID, _  = ParseHex("6ba7b812-9dad-11d1-80b4-00c04fd430c8")
	NamespaceX500, _ = ParseHex("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
)
```

--------------------------------

### Generate version 3 UUID

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Generates a UUID based on the MD5 hash of a namespace and a name.

```go
func NewV3(ns *UUID, name []byte) (u *UUID, err error)
```

--------------------------------

### Generate version 5 UUID

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Generates a UUID based on the SHA-1 hash of a namespace and a name.

```go
func NewV5(ns *UUID, name []byte) (u *UUID, err error)
```

--------------------------------

### Parse UUID from hex string

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Creates a UUID object from various hex string formats.

```go
func ParseHex(s string) (u *UUID, err error)
```

```go
uuid.ParseHex("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
uuid.ParseHex("{6ba7b814-9dad-11d1-80b4-00c04fd430c8}")
uuid.ParseHex("urn:uuid:6ba7b814-9dad-11d1-80b4-00c04fd430c8")
```

--------------------------------

### Parse UUID from bytes

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Creates a UUID object from a byte slice.

```go
func Parse(b []byte) (u *UUID, err error)
```

--------------------------------

### Generate version 4 UUID

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Generates a random UUID.

```go
func NewV4() (u *UUID, err error)
```

--------------------------------

### Define UUID reserved variants

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

Constants representing the reserved variants for UUIDs.

```go
const (
	ReservedNCS       byte = 0x80
	ReservedRFC4122   byte = 0x40
	ReservedMicrosoft byte = 0x20
	ReservedFuture    byte = 0x00
)
```

--------------------------------

### Define UUID type

Source: https://pkg.go.dev/github.com/nu7hatch/gouuid

The internal representation of a UUID as a 16-byte array.

```go
type UUID [16]byte
```
Tokens:
Raw