# `UtcOffset`

A fixed gap from UTC, in minutes: `+05:30`.

Use it to record the offset a device or a message reported. For a place, use [`Zone`](/docs/types/type-zone.md), which follows the place's daylight saving rules.

## Shape

| Field | Type | Required? |
|---|---|---|
| `minutes` | `Int` | Yes |

## Example

```jadpo
UtcOffset { minutes: 330 }
```

`text.parse(raw, as: UtcOffset)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `Z`, `+0100` or `+01`.

## Good to know

- UTC itself is `+00:00`. `Z` is refused.
- `==` 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
"+00:00"
"+05:30"
"-05:00"
```

## Details

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

`UtcOffset` is in the group Time and calendar, 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: `+00:00`, `+05:30` and `-05:00`.

### How it is stored

It is stored in one column named for the field, of type `smallint`. `+05:30` is stored as `330`.

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `+00:00` | `GMT+00:00` |
| `+05:30` | `GMT+05:30` |
| `-05:00` | `GMT-05:00` |

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