README
¶
id
Package id defines a globally unique 128-bit identifier.
Usage Example
Calling id.New() produces a new, unique id.ID:
userID := id.New()
fmt.Printf("%v", userID)
15bffdea7ae1138c6c57ad5fb01ed08a
Structure
An id.ID is actually defined as [16]byte under the hood. Generating a new
id.ID takes the current time, with nanosecond precision, and converts this to
a uint64. This becomes the first 64 bits of the identifier. The last 64 bits
are read from a CSPRNG.
Interfaces
The id.ID type satisfies a number of interfaces:
-
fmt.Stringer- Returns the identifier in string format, e.g."15bffdea7ae1138c6c57ad5fb01ed08a" -
json.Marshaler- Marshals to a JSON string, like above. -
json.Unmarshaler- Marshals from a JSON string. -
driver.Value- Converts to a string to be stored in SQL databases. -
sql.Scanner- Parses strings from SQL queries.
Documentation
¶
Index ¶
Constants ¶
const ByteSize = 16
ByteSize defines the size of the identifiers produced by this package, in bytes.
Variables ¶
var Empty = ID{}
Empty represents the empty ID (a sequence of 128 0 bits).
Functions ¶
This section is empty.
Types ¶
type ID ¶
ID represents a unique 128-bit identifier.
func (ID) MarshalJSON ¶
MarshalJSON returns the JSON value of an ID.
func (*ID) UnmarshalJSON ¶
UnmarshalJSON returns the parsed ID from a JSON value.
Source Files