# `UrlPath`

A URL's path (RFC 3986): `/` and its segments, with no query or fragment, `/products/42`. Every path is a `RelativeUrl`.

[Web and network](types.md#web-and-network); not ordered; since Jadpo 0.1.0.

## Make one

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

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

## 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 |
|---|---|
| `/` | `"/"` |
| `/products/42` | `"/products/42"` |
| `/search/caf%C3%A9` | `"/search/caf%C3%A9"` |
| `/docs/` | `"/docs/"` |

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

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