# `Cve`

A CVE record's id (the CVE programme's ID syntax): `CVE-2021-44228`.

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

## Make one

Build one from its text, `Cve("CVE-2014-0160")`, which checks it: text that isn't one breaks `format`.

`text.parse(raw, as: Cve)` reads one from its text; text that isn't one at all fails `malformed`, such as `cve-2014-0160`, `CVE-1998-0001` or `CVE-2014-160`.

## 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 |
|---|---|
| `CVE-2014-0160` | `"CVE-2014-0160"` |
| `CVE-2021-44228` | `"CVE-2021-44228"` |
| `CVE-1999-0001` | `"CVE-1999-0001"` |
| `CVE-2024-1234567` | `"CVE-2024-1234567"` |

It is stored in one column named for the field, of type `text`. `CVE-1999-0001` is stored as `'CVE-1999-0001'`.

## Shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `CVE-2014-0160` | `CVE-2014-0160` |
| `CVE-2021-44228` | `CVE-2021-44228` |
| `CVE-1999-0001` | `CVE-1999-0001` |
| `CVE-2024-1234567` | `CVE-2024-1234567` |

## 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.