# `UrlPath`

A URL's path, starting with `/`: `/products/42`.

Use it for a path on your own site. For a whole address, use [`Url`](/docs/types/type-url.md). For a query or `../` as well, use [`RelativeUrl`](/docs/types/type-relative-url.md).

## Shape

One value, held as text in one set form, with no parts: `/docs/`.

## Example

```jadpo
UrlPath("/products/42")
```

`UrlPath(raw)` checks the text, and text that isn't one breaks the `format` rule.

`text.parse(raw, as: UrlPath)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `products/42`, `//cdn.example.com` or `/a b`.

## Good to know

- It has no query or fragment, so `/a?x=1` is refused.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

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

```json
"/"
"/products/42"
"/search/caf%C3%A9"
```

## Details

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

`UrlPath` is in the group Web and network, 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: `/`, `/products/42` and `/search/caf%C3%A9`.

### How it is stored

It is stored in one column named for the field, of type `text`. `/search/caf%C3%A9` is stored as `'/search/caf%C3%A9'`.

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `/` | `/` |
| `/products/42` | `/products/42` |
| `/search/caf%C3%A9` | `/search/caf%C3%A9` |
| `/docs/` | `/docs/` |

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