# `Ulid`

A ULID (the ULID specification): 26 characters of Crockford's base 32 in upper case, `01ARZ3NDEKTSV4RRFFQ69G5FAV`.

[Software](types.md#software); not ordered; since Jadpo 0.1.0.

## Make one

Build one from its text, `Ulid("01ARZ3NDEKTSV4RRFFQ69G5FAV")`, which checks it: text that isn't one breaks `format`.

`text.parse(raw, as: Ulid)` reads one from its text; text that isn't one at all fails `malformed`, such as `8ZZZZZZZZZZZZZZZZZZZZZZZZZ`, `01arz3ndektsv4rrffq69g5fav` or `01ARZ3NDEKTSV4RRFFQ69G5FAI`.

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `01ARZ3NDEKTSV4RRFFQ69G5FAV` | `"01ARZ3NDEKTSV4RRFFQ69G5FAV"` |
| `7ZZZZZZZZZZZZZZZZZZZZZZZZZ` | `"7ZZZZZZZZZZZZZZZZZZZZZZZZZ"` |

It is stored in one column named for the field, of type `text`. `7ZZZZZZZZZZZZZZZZZZZZZZZZZ` is stored as `'7ZZZZZZZZZZZZZZZZZZZZZZZZZ'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `01ARZ3NDEKTSV4RRFFQ69G5FAV` | `01ARZ3NDEKTSV4RRFFQ69G5FAV` |
| `7ZZZZZZZZZZZZZZZZZZZZZZZZZ` | `7ZZZZZZZZZZZZZZZZZZZZZZZZZ` |

## Operations

It has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.