# `OAuthScope`

An OAuth scope (RFC 6749 §3.3): one scope-token of printable ASCII but the space, `"` and `\`, `todos:read`.

[Security](types.md#security); not ordered; since Jadpo 0.1.0.

## Make one

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

`text.parse(raw, as: OAuthScope)` reads one from its text; text that isn't one at all fails `malformed`, such as `openid email`, `say"hi"` or `back\slash`.

## 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 |
|---|---|
| `openid` | `"openid"` |
| `profile:read` | `"profile:read"` |
| `https://www.googleapis.com/auth/userinfo.email` | `"https://www.googleapis.com/auth/userinfo.email"` |

It is stored in one column named for the field, of type `text`. `profile:read` is stored as `'profile:read'`.

## Shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `openid` | `openid` |
| `profile:read` | `profile:read` |
| `https://www.googleapis.com/auth/userinfo.email` | `https://www.googleapis.com/auth/userinfo.email` |

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