solid-pod-rs 0.4.0-alpha.4

Rust-native Solid Pod server library — LDP, WAC, WebID, Solid-OIDC, Solid Notifications, NIP-98. Framework-agnostic.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

# `Prefer` header reference

The `Prefer` header (RFC 7240) allows a client to ask for a specific
container representation. solid-pod-rs parses preferences via
[`ldp::PreferHeader::parse`](../../src/ldp.rs).

## Supported preferences

Only `return=representation` preferences with `include=` or `omit=`
tokens are honoured. All other tokens are ignored (RFC 7240 §2 permits
this).

| IRI | Effect |
|---|---|
| `http://www.w3.org/ns/ldp#PreferMinimalContainer` | `representation = MinimalContainer`; container metadata only, no `ldp:contains`. |
| `http://www.w3.org/ns/ldp#PreferContainedIRIs`    | `representation = ContainedIRIsOnly`; list of IRIs only, no container metadata. |
| `http://www.w3.org/ns/ldp#PreferMembership`       | (in `omit=`) `omit_membership = true` — not currently enforced independently; merged with `MinimalContainer`. |

## Parsed shape

```rust
pub enum ContainerRepresentation { Full, MinimalContainer, ContainedIRIsOnly }

pub struct PreferHeader {
    pub representation:         ContainerRepresentation,
    pub include_minimal:        bool,
    pub include_contained_iris: bool,
    pub omit_membership:        bool,
}
```

`PreferHeader::default()` yields `representation = Full` — all four
fields are `false` / `Full`.

## Worked examples

### `Prefer: return=representation; include="http://www.w3.org/ns/ldp#PreferMinimalContainer"`

Parsed as:

```rust
PreferHeader {
    representation: ContainerRepresentation::MinimalContainer,
    include_minimal: true,
    include_contained_iris: false,
    omit_membership: false,
}
```

Response body (JSON-LD):

```json
{
  "@context": {
    "ldp":     "http://www.w3.org/ns/ldp#",
    "dcterms": "http://purl.org/dc/terms/"
  },
  "@id":   "/notes/",
  "@type": ["ldp:Container", "ldp:BasicContainer", "ldp:Resource"]
}
```

### `Prefer: return=representation; include="http://www.w3.org/ns/ldp#PreferContainedIRIs"`

```rust
PreferHeader {
    representation: ContainerRepresentation::ContainedIRIsOnly,
    include_minimal: false,
    include_contained_iris: true,
    omit_membership: false,
}
```

Response body:

```json
{
  "@id": "/notes/",
  "ldp:contains": [
    { "@id": "/notes/a.txt" },
    { "@id": "/notes/b.txt" }
  ]
}
```

### No `Prefer` header (default)

`PreferHeader::default()` → `representation = Full`. Full JSON-LD
document with `@context`, types, and `ldp:contains` entries carrying
both `@id` and `@type`.

## Multi-token parsing

The parser tolerates comma-separated preference lists:

```
Prefer: handling=strict,
        return=representation; include="http://www.w3.org/ns/ldp#PreferMinimalContainer"
```

`handling=strict` is ignored; the `return=representation` block is
applied.

## Tests

- `prefer_minimal_container_parsed`
- `prefer_contained_iris_parsed`
- `render_container_minimal_omits_contains`

in [`src/ldp.rs`](../../src/ldp.rs).

## See also

- [reference/content-types.md](content-types.md)
- [reference/api.md §ldp](api.md#ldp)
- [LDP §4.2.2](https://www.w3.org/TR/ldp/#ldp-prefer-parameters)
- [RFC 7240](https://datatracker.ietf.org/doc/html/rfc7240)