https://github.com/r4gus/uuid-zig

A UUID library written in Zig
https://github.com/r4gus/uuid-zig

guid rfc4122 uuid uuid-v4 uuid-v7 uuidv4 uuidv7 zig zig-lang ziglang

Last synced: 3 months ago
JSON representation

A UUID library written in Zig

• Host: GitHub
• URL: https://github.com/r4gus/uuid-zig
• Owner: r4gus
• License: mit
• Created: 2022-10-29T22:05:18.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-08T09:23:34.000Z (7 months ago)
• Last Synced: 2024-10-01T03:22:46.953Z (3 months ago)
• Topics: guid, rfc4122, uuid, uuid-v4, uuid-v7, uuidv4, uuidv7, zig, zig-lang, ziglang
• Language: Zig
• Homepage:
• Size: 1.88 MB
• Stars: 15
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: license

Awesome Lists containing this project

README

        
# UUID Zig

Universally Unique IDentifiers (UUIDs) are 128 bit long IDs that do not require a central

registration process.

## Getting started

To generate a version 4 (random) UUID you can use:

```zig

const uuid = @import("uuid");

const id = uuid.v4.new();

```

You can serialize a UUID into a URN:

```zig

const uuid = @import("uuid");

const id = uuid.v7.new();

const urn = uuid.urn.serialize(id);

```

You can also parse URNs (UUID strings):

```zig

const uuid = @import("uuid");

const id = try uuid.urn.deserialize("6ba7b811-9dad-11d1-80b4-00c04fd430c8");

```

## Which UUID version should I use?

Consider version 4 (`v4`) UUIDs if you just need unique identifiers and version 7 (`v7`)

if you want to use UUIDs as database keys or need to sort them.

### Supported versions

* `v4` - UUIDs using random data.

* `v7` - UUIDs using a Epoch timestamp in combination with random data.

## Encoding

This library encodes UUIDs in big-endian format, e.g. `00112233-4455-6677-8899-aabbccddeeff`

is encoded as `00 11 22 33 44 55 66 77 88 99 aa bb cc dd ee ff` where `00` is the least and

`ff` is the most significant byte (see [RFC4122 4.1.2 Layout and Byte Order](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.2)).

## Benchmark

To run a simple benchmark execute:

```

zig build bench -- 10000000 v7

```

Example: ThinkPad X1 Yoga 3rd with an i7-8550U

```

v4: 10000000 UUIDs in 595.063ms

v7: 10000000 UUIDs in 892.564ms

```

## References

* [RFC4122: A Universally Unique IDentifier (UUID) URN Namespace](https://datatracker.ietf.org/doc/html/rfc4122)

* [New UUID Formats: draft-peabody-dispatch-new-uuid-format-04](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format)