# `Bearing`

A compass direction: degrees clockwise from true north, from 0 to 360.

Use it for which way something is heading. `geo.bearing` gives one between two points. For an angle that isn't a direction, use [`Angle`](/docs/types/type-angle.md).

## Shape

One `Decimal` from 0 to 360.

## Example

```jadpo
Bearing(247.5)
```

A value outside its limits breaks `min` or `max`.

`text.parse(raw, as: Bearing)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `90°`, `N` or `1.5rad`.

This operation gives one: `geo.bearing`.

## Good to know

- `text.format` shows `247.5°`.
- `==` tells you whether two are the same, and `<` and `list.sort_by` compare and sort them.

## In JSON

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

```json
"0"
"90"
"247.5"
```

## Details

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

`Bearing` is in the group Geospatial, 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: `0`, `90` and `247.5`.

### How it is stored

It is stored in one column named for the field, of type `numeric`. `247.5` is stored as `247.5`.

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `0` | `0°` |
| `90` | `90°` |
| `247.5` | `247.5°` |
| `359.9` | `359.9°` |

### Operations

- `geo.bearing(from: Point, to: Point) -> Bearing`: The direction the geodesic leaves `from` in, in degrees clockwise from true north, at least 0 and below 360, to 9 places. Two equal points have none: the call fails with `same_point`, which its `attempt` maps.

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>