uniq

package module
Version: v0.0.0-...-f771e67 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2020 License: Apache-2.0 Imports: 5 Imported by: 2

README

No Hassle Unique Identifiers in Go (golang)

Go Report Card Coverage GoDoc

go get gitlab.com/rwxrob/uniq

Package uniq is a utility package that provides common random unique identifiers in UUID, Base32, and n*2 random hexadecimal characters.

6c671957-2f39-4ce5-9f0e-e8d5ec53bfde (16 bytes, 36 chars, hex-)
H6M0STKP0MTSU0493GERQDCSJ5BMF3VO     (20 bytes, 32 chars, base32)
5b ...                               (n bytes, n*2 chars, hex)

When a simple random identifier is all that is needed Base32() provides a better alternative to UUID(). It takes less space (32 characters), is safe for use with all filesystems including case insensitive ones, and provides additional randomness increased from 2^128 (uuid) to 2^160 (base32).

This package includes the following convenience commands as well for use when integrating with shell scripts:

  • uuid
  • uid32
  • randhex [COUNT]

Documentation

Overview

Package uniq is a utility package that provides common random unique identifiers in UUID, Base32, and n*2 random hexadecimal characters.

6c671957-2f39-4ce5-9f0e-e8d5ec53bfde (16 bytes, 36 chars, hex-)
H6M0STKP0MTSU0493GERQDCSJ5BMF3VO     (20 bytes, 32 chars, base32)
1561158139                           (8 bytes, 10+ chars, int64)
5b ...                               (n bytes, n*2 chars, hex)

When a simple random identifier is all that is needed Base32() provides a better alternative to UUID(). It takes less space (32 characters), is safe for use with all filesystems including case-insensitive ones, and provides additional randomness increased from 2^128 (uuid) to 2^160 (base32).

This package includes the following convenience commands as well for use when integrating with shell scripts:

uuid
uid32
epoch [SECONDS]
randhex [COUNT]
Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	uid32 := uniq.Base32()
	uuid := uniq.UUID()
	hexid := uniq.Hex(18)
	rgb := uniq.Hex(3)
	b := uniq.Hex(1)

	fmt.Println(uid32) // BCF1KFRJMSAQ1G9HCQ3L25CQOHFIGNQF
	fmt.Println(uuid)  // e98ee42a-d820-4bff-9b0e-67bcff639a17
	fmt.Println(hexid) // 98af788e67de0032b86bb3a3b04f935e72bb
	fmt.Println(rgb)   // 35ba0f
	fmt.Println(b)     // b9

}
Output:

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Base32

func Base32() string

Base32 returns a base32 encoded 20 byte string. This has a greater range than UUID() and is safe for use with filesystems. Base32 is rendered in uppercase for clarity and because it is case insensitive. Base32 depends on 40 bit chunks. 20 bytes exceeds UUID() randomness and is the closest. (15 would be insufficient to cover the same range.) Base32() is therefore superior to UUID() both in range of randomness and practicality. Returns an empty string if unable to read random data.

Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	uid32 := uniq.Base32()
	fmt.Println(len(uid32))

}
Output:

32

func Bytes

func Bytes(n int) []byte

Bytes returns n number of cryptographically secure pseudo-random bytes or a zero length slice if unable to read them from the hosting device.

Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	bytes := fmt.Sprintf("%x", uniq.Bytes(4))
	fmt.Println(len(bytes))

}
Output:

8

func Hex

func Hex(n int) string

Hex returns a random hexadecimal string that is n*2 characters in length. Calling Hex(18) is superior to UUID() and fits into the same 36 character space. Base32() remains superior, but sometimes content limitations and validators require only hexadecimal characters. Hex() can also be used to generate random RGB colors with Hex(3). Returns empty string if unable to read random data from host device.

Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	hex1 := uniq.Hex(1)
	hex3 := uniq.Hex(3)
	hex18 := uniq.Hex(18)
	fmt.Println(len(hex1))
	fmt.Println(len(hex3))
	fmt.Println(len(hex18))

}
Output:

2
6
36

func Second

func Second() string

Second returns the current (time.Unix()) second since Jan 1, 1970 UTC. This is frequently a very good unique suffix that has the added advantage of being chronologically sortable.

Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	sec := uniq.Second()
	fmt.Println(len(sec))

}
Output:

10

func UUID

func UUID() string

UUID returns a standard UUID v4 according to RFC 4122. UUIDs have become deeply entrenched universally but are inferior to Base32 as the need for a greater range of randomness emerges (IPv6, etc.) Returns empty string if unable to read random data for any reason.

Example
package main

import (
	"fmt"

	"gitlab.com/rwxrob/uniq"
)

func main() {

	uuid := uniq.UUID()
	fmt.Println(len(uuid))

}
Output:

36

Types

This section is empty.

Source Files

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL