# `FilePath`

A portable file path: `/var/lib/acme/uploads`, `reports/2026/october.csv`.

Use it for a path in config. For a name with no folders, use [`FileName`](/docs/types/type-file-name.md).

## Shape

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

## Example

```jadpo
FilePath("reports/2026/october.csv")
```

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

`text.parse(raw, as: FilePath)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `./reports`, `reports/../logo.png` or `/../etc/passwd`.

## Good to know

- It uses `/` and its shortest form, so `./reports` and `a/../b` are refused.
- It doesn't check that the file exists.
- `==` 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
"/var/lib/acme/uploads"
"reports/2026/october.csv"
"../shared/logo.png"
```

## Details

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

`FilePath` is in the group Software, 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: `/var/lib/acme/uploads`, `reports/2026/october.csv` and `../shared/logo.png`.

### How it is stored

It is stored in one column named for the field, of type `text`. `../shared/logo.png` is stored as `'../shared/logo.png'`.

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `/var/lib/acme/uploads` | `/var/lib/acme/uploads` |
| `reports/2026/october.csv` | `reports/2026/october.csv` |
| `../shared/logo.png` | `../shared/logo.png` |
| `/` | `/` |

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