Home

Awesome

<h1 align="center"> <br> <br> <img width="360" src="logo.png" alt="ulid"> <br> <br> <br> </h1>

Universally Unique Lexicographically Sortable Identifier in Nim

UUID can be suboptimal for many uses-cases because:

Instead, herein is proposed ULID:

Nim

Installation

nimble install ulid

Usage

import ulid

ulid()

Implementations in other languages

From the community!

LanguageAuthorBinary Implementation
C++suyash
Objective-Cricardopereira
CrystalSuperPaintman
Dartisoos
Delphimatinusso
Erlangsavonarola
Elixirmerongivian
Goimdario
Gooklog
Haskellsteven777400
Javahuxi
Javaazam
JavaLewiscowles1986
Juliaararslan
LuaTieske
.NETRobThree
.NETfvilers
Nimadelq
Perl 5bk
PHPLewiscowles1986
Pythonmdipierro
Rubyrafaelsales
Rustmmacedoeu
Rustdylanhart
Swiftsimonwhitehouse
Tcldbohdan

Specification

Below is the current specification of ULID as implemented in this repository.

Note: the binary format has not been implemented.

 01AN4Z07BY      79KA1307SR9X4MV3

|----------|    |----------------|
 Timestamp          Randomness
   48bits             80bits

Components

Timestamp

Randomness

Sorting

The left-most character must be sorted first, and the right-most character sorted last (lexical order). The default ASCII character set must be used. Within the same millisecond, sort order is not guaranteed

Encoding

Crockford's Base32 is used as shown. This alphabet excludes the letters I, L, O, and U to avoid confusion and abuse.

0123456789ABCDEFGHJKMNPQRSTVWXYZ

Binary Layout and Byte Order

The components are encoded as 16 octets. Each component is encoded with the Most Significant Byte first (network byte order).

0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-+
|                      32_bit_uint_time_high                    |
+-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-+
|     16_bit_uint_time_low      |       16_bit_uint_random      |
+-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-+
|                       32_bit_uint_random                      |
+-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-+
|                       32_bit_uint_random                      |
+-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-+

String Representation

ttttttttttrrrrrrrrrrrrrrrr

where
t is Timestamp
r is Randomness

Prior Art

Inspired by:

Partly inspired by:

Test Suite

nimble test

Performance

nimble perf
ulid.nim                                                  time/iter  iters/s
============================================================================
encode_time                                                319.93ns    3.13M
encode_random                                                3.57us  280.33K
ulid                                                         3.85us  259.78K