orion-error 0.8.1

Struct Error for Large Project
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

# Report / Exposure Boundary

This document describes the responsibility boundary between `DiagnosticReport` and `ErrorProtocolSnapshot`.

## Current State

`category` and `code` have been removed from `DiagnosticReport`. Identity data now lives exclusively in `ErrorProtocolSnapshot.identity`. All exposure bridge methods on `DiagnosticReport` (`exposure_identity`, `http_status`, `visibility`, `default_hints`, `decision`, `exposure`, `to_exposure_json`) have been deleted.

`StructError<T>::report()` only requires `DomainReason`, not `ErrorIdentityProvider`.

## 1. Object Roles

| Object | Responsibility |
|--------|---------------|
| `StructError<R>` | Runtime propagation, source chain, context attachment |
| `DiagnosticReport` | Human diagnostic view, redaction, text rendering |
| `ErrorProtocolSnapshot` | Identity + exposure decision + report, user debug, protocol JSON projection |

## 2. Recommended Primary Paths

**Human diagnostics:**
```rust
let report = err.report();
let text = report.render();
```

**Protocol/projection:**
```rust
let proto = err.exposure(&policy);
let debug = proto.render_user_debug();
let http = proto.to_http_error_json()?;
```

## 3. Principles

- `DiagnosticReport` stays a diagnostic object.
- `ErrorProtocolSnapshot` is the sole exposure/projection closure.
- `StructError` routes runtime errors into either report or protocol layer.

In short:
- Need text diagnostics → `report()`
- Need exposure / JSON projection → `exposure(…)`

## 4. From DiagnosticReport to Protocol

If the caller starts from an existing `DiagnosticReport` (not `StructError`):

```rust
let proto = ErrorProtocolSnapshot::from_report_skeleton(report, identity, &policy);
```

But if full projection data (root metadata, source frames, path) is needed, prefer `StructError::exposure(...)`.

## 5. Summary

The current design keeps `DiagnosticReport` focused on diagnostics while `ErrorProtocolSnapshot` handles all exposure and projection concerns. The two paths are independent and should not be mixed.