waddling-errors-macros 0.7.3

Procedural macros for structured error codes with compile-time validation and taxonomy enforcement
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

# 🦆 waddling-errors-macros

Procedural macros for [waddling-errors](../waddling-errors).

[![Crates.io](https://img.shields.io/crates/v/waddling-errors-macros.svg)](https://crates.io/crates/waddling-errors-macros)
[![Documentation](https://docs.rs/waddling-errors-macros/badge.svg)](https://docs.rs/waddling-errors-macros)

---

## Installation

```toml
[dependencies]
waddling-errors = "0.7"
waddling-errors-macros = "0.7"
```

---

## Quick Start

> `setup!` must be called once at crate root before using `diag!`.
> Module names (`components`, `primaries`, `sequences`) are conventions—use whatever structure fits your project.

```rust
// src/lib.rs
use waddling_errors_macros::{setup, component, primary, sequence, diag};

setup! {
    components = crate::components,
    primaries = crate::primaries,
    sequences = crate::sequences,
}

pub mod components {
    use waddling_errors_macros::component;
    component! { Auth { docs: "Authentication" } }
}

pub mod primaries {
    use waddling_errors_macros::primary;
    primary! { Token { docs: "Token errors" } }
}

pub mod sequences {
    use waddling_errors_macros::sequence;
    sequence! {
        EXPIRED(17) { description: "Resource expired" },
    }
}

diag! {
    E.Auth.Token.EXPIRED: {
        message: "Token expired at {{timestamp}}",
        fields: [timestamp],
        
        'Pub description: "Session expired. Please log in again.",
        'Dev description: "Token TTL exceeded. Check refresh logic.",
        'Int description: "Check auth_tokens table.",
    },
}

// Use it
let error = E_AUTH_TOKEN_EXPIRED;
println!("{}", error.runtime.code);  // E.Auth.Token.017
```

---

## Macros

### `setup!` - Configure paths (required at crate root)

```rust
setup! {
    components = crate::components,
    primaries = crate::primaries,
    sequences = crate::sequences,
}
```

### `component!` - Define components

```rust
component! {
    Auth { docs: "Authentication system" },
    Database { docs: "Database operations" },
}
```

### `primary!` - Define primary categories

```rust
primary! {
    Token { docs: "Token-related errors" },
    Connection { docs: "Connection errors" },
}
```

### `sequence!` - Define sequences

```rust
sequence! {
    MISSING(1) { description: "Required item missing" },
    EXPIRED(17) { description: "Resource expired" },
}
```

### `diag!` - Define diagnostics

```rust
diag! {
    E.Auth.Token.EXPIRED: {
        message: "Token expired at {{timestamp}}",
        fields: [timestamp],
        pii: [user_email],  // PII fields use {{pii/field}}
        
        // Role-based descriptions
        'Pub description: "Session expired.",
        'Dev description: "Token TTL exceeded.",
        'Int description: "Check auth_tokens table.",
        
        role: "Public",
        tags: ["auth"],
    },
}
```

---

## Visibility Markers

| Marker | Context | Use Case |
|--------|---------|----------|
| `'C` | Compile-time only | URLs, code snippets |
| `'R` | Runtime only | Role, tags |
| `'CR` | Both | Descriptions, hints |

---

## Role-Based Documentation

```rust
diag! {
    E.Auth.Token.EXPIRED: {
        message: "Token expired",
        
        'Pub description: "Session expired.",           // End users
        'Dev description: "Token TTL exceeded.",        // Developers
        'Int description: "Redis key: auth:token:*",    // Internal
        
        role: "Public",
    },
}
```

Generate separate docs per role:
```bash
cargo run --bin doc-gen --features doc-gen
```

---

## Feature Flags

| Feature | Description | Default |
|---------|-------------|---------|
| `metadata` | Compile-time metadata | No |
| `doc-gen` | Documentation generation | No |
| `auto-register` | Automatic registration | No |

---

## Documentation

- [Macro Guide](docs/MACRO_GUIDE.md) - Complete syntax reference
- [Validation Guide](VALIDATION.md) - Compile-time validation
- [API Reference](https://docs.rs/waddling-errors-macros)

---

## License

MIT or Apache-2.0.