ulid-transform 1.4.0__tar.gz → 1.5.0__tar.gz

{ulid_transform-1.4.0 → ulid_transform-1.5.0}/PKG-INFO

@@ -1,20 +1,21 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ulid-transform
-Version: 1.4.0
+Version: 1.5.0
 Summary: Create and transform ULIDs
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
 Author: J. Nick Koston
 Author-email: nick@koston.org
-Requires-Python: >=3.11,<4.0
+Requires-Python: >=3.11
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries
 Project-URL: Bug Tracker, https://github.com/bluetooth-devices/ulid-transform/issues
 Project-URL: Changelog, https://github.com/bluetooth-devices/ulid-transform/blob/main/CHANGELOG.md

{ulid_transform-1.4.0 → ulid_transform-1.5.0}/pyproject.toml

@@ -1,20 +1,24 @@
-[tool.poetry]
+[project]
 name = "ulid-transform"
-version = "1.4.0"
-description = "Create and transform ULIDs"
-authors = ["J. Nick Koston <nick@koston.org>"]
+version = "1.5.0"
 license = "MIT"
+description = "Create and transform ULIDs"
 readme = "README.md"
-repository = "https://github.com/bluetooth-devices/ulid-transform"
+authors = [{ name = "J. Nick Koston", email = "nick@koston.org" }]
+requires-python = ">=3.11"
+
+[project.urls]
+"Repository" = "https://github.com/bluetooth-devices/ulid-transform"
+"Bug Tracker" = "https://github.com/bluetooth-devices/ulid-transform/issues"
+"Changelog" = "https://github.com/bluetooth-devices/ulid-transform/blob/main/CHANGELOG.md"
+
+[tool.poetry]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Libraries",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
 ]
 packages = [
     { include = "ulid_transform", from = "src" },
@@ -24,19 +28,15 @@ packages = [
 generate-setup-file = true
 script = "build_ext.py"
 
-[tool.poetry.urls]
-"Bug Tracker" = "https://github.com/bluetooth-devices/ulid-transform/issues"
-"Changelog" = "https://github.com/bluetooth-devices/ulid-transform/blob/main/CHANGELOG.md"
-
 [tool.poetry.dependencies]
 python = "^3.11"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7,<9"
-pytest-cov = ">=3,<7"
+pytest-cov = ">=3,<8"
 Cython = ">=3.0.5"
-setuptools = ">=65.4.1,<76.0.0"
-pytest-codspeed = "^3.1.2"
+setuptools = ">=65.4.1,<80.0.0"
+pytest-codspeed = ">=3.1.2,<5.0.0"
 
 
 [tool.poetry.group.benchmark.dependencies]
@@ -45,7 +45,7 @@ ulid2 = "^0.3.0"
 pytest-benchmark = ">=4,<6"
 
 [tool.semantic_release]
-version_toml = ["pyproject.toml:tool.poetry.version"]
+version_toml = ["pyproject.toml:project.version"]
 version_variables = [
     "src/ulid_transform/__init__.py:__version__",
 ]
@@ -66,10 +66,6 @@ exclude_lines = [
     'if __name__ == "__main__":',
 ]
 
-[tool.isort]
-profile = "black"
-known_first_party = ["ulid_transform", "tests"]
-
 [tool.mypy]
 check_untyped_defs = true
 disallow_any_generics = true
@@ -92,6 +88,21 @@ allow_untyped_defs = true
 module = "bench.*"
 allow_untyped_defs = true
 
+[tool.ruff.lint]
+extend-select = [
+    "B",
+    "I",
+    "S",
+    "UP",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["ulid_transform", "tests"]
+
+[tool.ruff.lint.per-file-ignores]
+"bench/*" = ["S101"]
+"tests/*" = ["S101"]
+
 [build-system]
-requires = ['setuptools>=65.4.1', 'wheel', 'Cython>=3.0.2', "poetry-core>=1.0.0"]
+requires = ['setuptools>=77.0', 'Cython>=3.0.2', "poetry-core>=2.1.0"]
 build-backend = "poetry.core.masonry.api"

{ulid_transform-1.4.0 → ulid_transform-1.5.0}/setup.py

@@ -12,7 +12,7 @@ package_data = \
 
 setup_kwargs = {
     'name': 'ulid-transform',
-    'version': '1.4.0',
+    'version': '1.5.0',
     'description': 'Create and transform ULIDs',
     'long_description': '# Fast ULID transformations\n\n<p align="center">\n  <a href="https://github.com/bluetooth-devices/ulid-transform/actions/workflows/ci.yml?query=branch%3Amain">\n    <img src="https://img.shields.io/github/actions/workflow/status/bluetooth-devices/ulid-transform/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >\n  </a>\n  <a href="https://codecov.io/gh/bluetooth-devices/ulid-transform">\n    <img src="https://img.shields.io/codecov/c/github/bluetooth-devices/ulid-transform.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">\n  </a>\n</p>\n<p align="center">\n  <a href="https://python-poetry.org/">\n    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">\n  </a>\n  <a href="https://github.com/ambv/black">\n    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">\n  </a>\n  <a href="https://github.com/pre-commit/pre-commit">\n    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">\n  </a>\n  <a href="https://codspeed.io/bluetooth-devices/ulid-transform"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed Badge"/></a>\n</p>\n<p align="center">\n  <a href="https://pypi.org/project/ulid-transform/">\n    <img src="https://img.shields.io/pypi/v/ulid-transform.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">\n  </a>\n  <img src="https://img.shields.io/pypi/pyversions/ulid-transform.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">\n  <img src="https://img.shields.io/pypi/l/ulid-transform.svg?style=flat-square" alt="License">\n</p>\n\nCreate and transform ULIDs\n\nThis library will use the CPP implementation from https://github.com/suyash/ulid if cython is available, and will fallback to pure python if it is not.\n\n## Example\n\n```python\n>>> import ulid_transform\n>>> ulid_transform.ulid_hex()\n\'01869a2ea5fb0b43aa056293e47c0a35\'\n>>> ulid_transform.ulid_now()\n\'0001HZX0NW00GW0X476W5TVBFE\'\n>>> ulid_transform.ulid_at_time(1234)\n\'000000016JC62D620DGYNG2R8H\'\n>>> ulid_transform.ulid_to_bytes(\'0001HZX0NW00GW0X476W5TVBFE\')\nb\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\'\n>> ulid_transform.bytes_to_ulid(b"\\x01\\x86\\x99?\\xe8\\xf3\\x11\\xbc\\xed\\xef\\x86U.9\\x03z")\n\'01GTCKZT7K26YEVVW6AMQ3J0VT\'\n>>> ulid_transform.ulid_to_bytes_or_none(\'0001HZX0NW00GW0X476W5TVBFE\')\nb\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\'\n>>> ulid_transform.ulid_to_bytes_or_none(None)\n>>> ulid_transform.bytes_to_ulid_or_none(b\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\')\n\'0001HZX0NW00GW0X476W5TVBFE\'\n>>> ulid_transform.bytes_to_ulid_or_none(None)\n```\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install ulid-transform`\n\n## Contributors ✨\n\nThanks to https://github.com/suyash/ulid which provides the cython implementation guts.\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- prettier-ignore-start -->\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- markdownlint-disable -->\n<!-- markdownlint-enable -->\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-end -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## Credits\n\nThis package was created with\n[Copier](https://copier.readthedocs.io/) and the\n[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)\nproject template.\n',
     'author': 'J. Nick Koston',
@@ -23,7 +23,7 @@ setup_kwargs = {
     'package_dir': package_dir,
     'packages': packages,
     'package_data': package_data,
-    'python_requires': '>=3.11,<4.0',
+    'python_requires': '>=3.11',
 }
 from build_ext import *
 build(setup_kwargs)

{ulid_transform-1.4.0 → ulid_transform-1.5.0}/src/ulid_transform/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 
 try:
     from ._ulid_impl import (

ulid_transform-1.5.0/src/ulid_transform/ulid_struct.hh

@@ -0,0 +1,282 @@
+#ifndef ULID_STRUCT_HH
+#define ULID_STRUCT_HH
+
+#include <array>
+#include <chrono>
+#include <cstdlib>
+#include <ctime>
+#include <functional>
+#include <random>
+#include <vector>
+
+#if _MSC_VER > 0
+typedef uint32_t rand_t;
+#else
+typedef uint8_t rand_t;
+#endif
+
+namespace ulid {
+
+/**
+ * ULID is a 16 byte Universally Unique Lexicographically Sortable Identifier
+ * */
+struct ULID {
+    uint8_t data[16];
+};
+
+/**
+ * EncodeTimestamp will encode the int64_t timestamp to the passed ulid
+ * */
+inline void EncodeTimestamp(int64_t timestamp, ULID& ulid)
+{
+    ulid.data[0] = static_cast<uint8_t>(timestamp >> 40);
+    ulid.data[1] = static_cast<uint8_t>(timestamp >> 32);
+    ulid.data[2] = static_cast<uint8_t>(timestamp >> 24);
+    ulid.data[3] = static_cast<uint8_t>(timestamp >> 16);
+    ulid.data[4] = static_cast<uint8_t>(timestamp >> 8);
+    ulid.data[5] = static_cast<uint8_t>(timestamp);
+}
+
+/**
+ * EncodeTime will encode the time point to the passed ulid
+ * */
+inline void EncodeTime(std::chrono::time_point<std::chrono::system_clock> time_point, ULID& ulid)
+{
+    auto time_ms = std::chrono::time_point_cast<std::chrono::milliseconds>(time_point);
+    int64_t timestamp = time_ms.time_since_epoch().count();
+    EncodeTimestamp(timestamp, ulid);
+}
+
+/**
+ * EncodeTimeSystemClockNow will encode a ULID using the time obtained using
+ * std::chrono::system_clock::now() by taking the timestamp in milliseconds.
+ * */
+inline void EncodeTimeSystemClockNow(ULID& ulid)
+{
+    EncodeTime(std::chrono::system_clock::now(), ulid);
+}
+
+/**
+ * EncodeEntropyMt19937Fast will encode using std::mt19937
+ * with only 3 generated values.
+ * */
+inline void EncodeEntropyMt19937Fast(ULID& ulid)
+{
+    static thread_local std::mt19937 gen([]() {
+        // Use multiple entropy sources for seeding
+        std::array<uint32_t, 3> seed_data = {
+            static_cast<uint32_t>(std::chrono::high_resolution_clock::now().time_since_epoch().count()),
+            static_cast<uint32_t>(std::random_device {}()),
+            static_cast<uint32_t>(reinterpret_cast<uintptr_t>(&gen) & 0xFFFFFFFF)
+        };
+        std::seed_seq seed_seq(seed_data.begin(), seed_data.end());
+        return std::mt19937(seed_seq);
+    }());
+    uint64_t high = (static_cast<uint64_t>(gen()) << 32) | gen();
+    uint32_t low = gen();
+    ulid.data[6] = (high >> 40) & 0xFF;
+    ulid.data[7] = (high >> 32) & 0xFF;
+    ulid.data[8] = (high >> 24) & 0xFF;
+    ulid.data[9] = (high >> 16) & 0xFF;
+    ulid.data[10] = (high >> 8) & 0xFF;
+    ulid.data[11] = high & 0xFF;
+    ulid.data[12] = (low >> 24) & 0xFF;
+    ulid.data[13] = (low >> 16) & 0xFF;
+    ulid.data[14] = (low >> 8) & 0xFF;
+    ulid.data[15] = low & 0xFF;
+}
+
+/**
+ * Crockford's Base32
+ * */
+static const char Encoding[33] = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
+
+/**
+ * MarshalTo will marshal a ULID to the passed character array.
+ *
+ * Implementation taken directly from oklog/ulid
+ * (https://sourcegraph.com/github.com/oklog/ulid@0774f81f6e44af5ce5e91c8d7d76cf710e889ebb/-/blob/ulid.go#L162-190)
+ *
+ * timestamp:<br>
+ * dst[0]: first 3 bits of data[0]<br>
+ * dst[1]: last 5 bits of data[0]<br>
+ * dst[2]: first 5 bits of data[1]<br>
+ * dst[3]: last 3 bits of data[1] + first 2 bits of data[2]<br>
+ * dst[4]: bits 3-7 of data[2]<br>
+ * dst[5]: last bit of data[2] + first 4 bits of data[3]<br>
+ * dst[6]: last 4 bits of data[3] + first bit of data[4]<br>
+ * dst[7]: bits 2-6 of data[4]<br>
+ * dst[8]: last 2 bits of data[4] + first 3 bits of data[5]<br>
+ * dst[9]: last 5 bits of data[5]<br>
+ *
+ * entropy:
+ * follows similarly, except now all components are set to 5 bits.
+ * */
+inline void MarshalTo(const ULID& ulid, char dst[26])
+{
+    // 10 byte timestamp
+    dst[0] = Encoding[(ulid.data[0] & 224) >> 5];
+    dst[1] = Encoding[ulid.data[0] & 31];
+    dst[2] = Encoding[(ulid.data[1] & 248) >> 3];
+    dst[3] = Encoding[((ulid.data[1] & 7) << 2) | ((ulid.data[2] & 192) >> 6)];
+    dst[4] = Encoding[(ulid.data[2] & 62) >> 1];
+    dst[5] = Encoding[((ulid.data[2] & 1) << 4) | ((ulid.data[3] & 240) >> 4)];
+    dst[6] = Encoding[((ulid.data[3] & 15) << 1) | ((ulid.data[4] & 128) >> 7)];
+    dst[7] = Encoding[(ulid.data[4] & 124) >> 2];
+    dst[8] = Encoding[((ulid.data[4] & 3) << 3) | ((ulid.data[5] & 224) >> 5)];
+    dst[9] = Encoding[ulid.data[5] & 31];
+
+    // 16 bytes of entropy
+    dst[10] = Encoding[(ulid.data[6] & 248) >> 3];
+    dst[11] = Encoding[((ulid.data[6] & 7) << 2) | ((ulid.data[7] & 192) >> 6)];
+    dst[12] = Encoding[(ulid.data[7] & 62) >> 1];
+    dst[13] = Encoding[((ulid.data[7] & 1) << 4) | ((ulid.data[8] & 240) >> 4)];
+    dst[14] = Encoding[((ulid.data[8] & 15) << 1) | ((ulid.data[9] & 128) >> 7)];
+    dst[15] = Encoding[(ulid.data[9] & 124) >> 2];
+    dst[16] = Encoding[((ulid.data[9] & 3) << 3) | ((ulid.data[10] & 224) >> 5)];
+    dst[17] = Encoding[ulid.data[10] & 31];
+    dst[18] = Encoding[(ulid.data[11] & 248) >> 3];
+    dst[19] = Encoding[((ulid.data[11] & 7) << 2) | ((ulid.data[12] & 192) >> 6)];
+    dst[20] = Encoding[(ulid.data[12] & 62) >> 1];
+    dst[21] = Encoding[((ulid.data[12] & 1) << 4) | ((ulid.data[13] & 240) >> 4)];
+    dst[22] = Encoding[((ulid.data[13] & 15) << 1) | ((ulid.data[14] & 128) >> 7)];
+    dst[23] = Encoding[(ulid.data[14] & 124) >> 2];
+    dst[24] = Encoding[((ulid.data[14] & 3) << 3) | ((ulid.data[15] & 224) >> 5)];
+    dst[25] = Encoding[ulid.data[15] & 31];
+}
+
+/**
+ * MarshalBinaryTo will Marshal a ULID to the passed byte array
+ * */
+inline void MarshalBinaryTo(const ULID& ulid, uint8_t dst[16])
+{
+    // timestamp
+    dst[0] = ulid.data[0];
+    dst[1] = ulid.data[1];
+    dst[2] = ulid.data[2];
+    dst[3] = ulid.data[3];
+    dst[4] = ulid.data[4];
+    dst[5] = ulid.data[5];
+
+    // entropy
+    dst[6] = ulid.data[6];
+    dst[7] = ulid.data[7];
+    dst[8] = ulid.data[8];
+    dst[9] = ulid.data[9];
+    dst[10] = ulid.data[10];
+    dst[11] = ulid.data[11];
+    dst[12] = ulid.data[12];
+    dst[13] = ulid.data[13];
+    dst[14] = ulid.data[14];
+    dst[15] = ulid.data[15];
+}
+
+/**
+ * dec storesdecimal encodings for characters.
+ * 0xFF indicates invalid character.
+ * 48-57 are digits.
+ * 65-90 are capital alphabets.
+ * */
+static const uint8_t dec[256] = {
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    /* 0     1     2     3     4     5     6     7  */
+    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+    /* 8     9                                      */
+    0x08, 0x09, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    /*    10(A) 11(B) 12(C) 13(D) 14(E) 15(F) 16(G) */
+    0xFF, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10,
+    /*17(H)     18(J) 19(K)       20(M) 21(N)       */
+    0x11, 0xFF, 0x12, 0x13, 0xFF, 0x14, 0x15, 0xFF,
+    /*22(P)23(Q)24(R) 25(S) 26(T)       27(V) 28(W) */
+    0x16, 0x17, 0x18, 0x19, 0x1A, 0xFF, 0x1B, 0x1C,
+    /*29(X)30(Y)31(Z)                               */
+    0x1D, 0x1E, 0x1F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+    0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
+};
+
+/**
+ * UnmarshalFrom will unmarshal a ULID from the passed character array.
+ * */
+inline void UnmarshalFrom(const char str[26], ULID& ulid)
+{
+    // timestamp
+    ulid.data[0] = (dec[int(str[0])] << 5) | dec[int(str[1])];
+    ulid.data[1] = (dec[int(str[2])] << 3) | (dec[int(str[3])] >> 2);
+    ulid.data[2] = (dec[int(str[3])] << 6) | (dec[int(str[4])] << 1) | (dec[int(str[5])] >> 4);
+    ulid.data[3] = (dec[int(str[5])] << 4) | (dec[int(str[6])] >> 1);
+    ulid.data[4] = (dec[int(str[6])] << 7) | (dec[int(str[7])] << 2) | (dec[int(str[8])] >> 3);
+    ulid.data[5] = (dec[int(str[8])] << 5) | dec[int(str[9])];
+
+    // entropy
+    ulid.data[6] = (dec[int(str[10])] << 3) | (dec[int(str[11])] >> 2);
+    ulid.data[7] = (dec[int(str[11])] << 6) | (dec[int(str[12])] << 1) | (dec[int(str[13])] >> 4);
+    ulid.data[8] = (dec[int(str[13])] << 4) | (dec[int(str[14])] >> 1);
+    ulid.data[9] = (dec[int(str[14])] << 7) | (dec[int(str[15])] << 2) | (dec[int(str[16])] >> 3);
+    ulid.data[10] = (dec[int(str[16])] << 5) | dec[int(str[17])];
+    ulid.data[11] = (dec[int(str[18])] << 3) | (dec[int(str[19])] >> 2);
+    ulid.data[12] = (dec[int(str[19])] << 6) | (dec[int(str[20])] << 1) | (dec[int(str[21])] >> 4);
+    ulid.data[13] = (dec[int(str[21])] << 4) | (dec[int(str[22])] >> 1);
+    ulid.data[14] = (dec[int(str[22])] << 7) | (dec[int(str[23])] << 2) | (dec[int(str[24])] >> 3);
+    ulid.data[15] = (dec[int(str[24])] << 5) | dec[int(str[25])];
+}
+
+/**
+ * UnmarshalBinaryFrom will unmarshal a ULID from the passed byte array.
+ * */
+inline void UnmarshalBinaryFrom(const uint8_t b[16], ULID& ulid)
+{
+    // timestamp
+    ulid.data[0] = b[0];
+    ulid.data[1] = b[1];
+    ulid.data[2] = b[2];
+    ulid.data[3] = b[3];
+    ulid.data[4] = b[4];
+    ulid.data[5] = b[5];
+
+    // entropy
+    ulid.data[6] = b[6];
+    ulid.data[7] = b[7];
+    ulid.data[8] = b[8];
+    ulid.data[9] = b[9];
+    ulid.data[10] = b[10];
+    ulid.data[11] = b[11];
+    ulid.data[12] = b[12];
+    ulid.data[13] = b[13];
+    ulid.data[14] = b[14];
+    ulid.data[15] = b[15];
+}
+
+}; // namespace ulid
+
+#endif // ULID_STRUCT_HH