# `ContentRating`

An age rating and the body that gave it: `BBFC 12A`.

Use it for films and games. The rating has to be one of that body's own categories, so `BBFC PG-13` is refused.

## Shape

| Field | Type | Required? |
|---|---|---|
| `scheme` | [`ContentRatingScheme`](/docs/types/type-content-rating-scheme.md) | Yes |
| `rating` | `Text` | Yes |

Its parts keep these rules, and a value that breaks one fails with the rule's name:

- `rating_of_scheme`: rating is one of its scheme's categories

## Example

```jadpo
ContentRating { scheme: ContentRatingScheme.bbfc rating: "12A" }
```

`text.parse(raw, as: ContentRating)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `BBFC PG-13`, `PEGI 15` or `MPAA R`.

## Good to know

- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it, so sort by one of its parts instead.

## In JSON

A string, in a request, a response or `json.write`:

```json
"BBFC 12A"
"MPA PG-13"
"PEGI 16"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`ContentRating` is in the group Media and visual, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `BBFC 12A`, `MPA PG-13` and `PEGI 16`.

### How it is stored

It is stored in 2 columns, each named for the field, `_` and its suffix. This is `PEGI 16`:

| Column | Type | Holds |
|---|---|---|
| `<field>_scheme` | `text` | `'PEGI'` |
| `<field>_rating` | `text` | `'16'` |

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `BBFC 12A` | `BBFC 12A` |
| `MPA PG-13` | `MPA PG-13` |
| `PEGI 16` | `PEGI 16` |
| `ESRB E10+` | `ESRB E10+` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>