arvo 1.0.0

Validated, immutable value objects for common domain types (email, money, identifiers, …)
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

# net module

Feature flag: `net`

```toml
[dependencies]
arvo = { version = "1.0", features = ["net"] }
```

---

## Url

A validated URL. Accepts `http`, `https`, `ftp`, `ftps`, `ws`, and `wss` schemes. Scheme and host are normalised to lowercase.

**Validation:** must be a valid URL with an allowed scheme and a host.

```rust,ignore
use arvo::net::Url;
use arvo::traits::{PrimitiveValue, ValueObject};

let url = Url::new("HTTPS://Example.COM/path".into())?;
assert_eq!(url.value(), "https://example.com/path");
assert_eq!(url.scheme(), "https");
assert_eq!(url.host(), "example.com");

let url: Url = "https://example.com".try_into()?;
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"https://example.com/path"` |
| `scheme()` | `&str` | `"https"` |
| `host()` | `&str` | `"example.com"` |
| `into_inner()` | `String` | `"https://example.com/path"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"not-a-url"` | `ValidationError::InvalidFormat` |
| `"mailto:user@example.com"` | `ValidationError::InvalidFormat` (scheme not allowed) |

---

## Domain

A validated domain name without a scheme (e.g. `"example.com"`).

**Normalisation:** trimmed, lowercased.
**Validation:** at least two labels, each 1–63 alphanumeric/hyphen characters, not starting or ending with a hyphen.

```rust,ignore
use arvo::net::Domain;
use arvo::traits::{PrimitiveValue, ValueObject};

let domain = Domain::new("Example.COM".into())?;
assert_eq!(domain.value(), "example.com");

let domain: Domain = "api.example.com".try_into()?;
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"example.com"` |
| `into_inner()` | `String` | `"example.com"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"localhost"` | `ValidationError::InvalidFormat` (single label) |
| `"-example.com"` | `ValidationError::InvalidFormat` (leading hyphen) |

---

## IpV4Address

A validated IPv4 address. Leading zeros in octets are rejected.

```rust,ignore
use arvo::net::IpV4Address;
use arvo::traits::{PrimitiveValue, ValueObject};

let ip = IpV4Address::new("192.168.1.1".into())?;
assert_eq!(ip.value(), "192.168.1.1");

let ip: IpV4Address = "10.0.0.1".try_into()?;
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"192.168.1.1"` |
| `is_loopback()` | `bool` | `true` for `127.0.0.0/8` |
| `is_private()` | `bool` | `true` for `10/8`, `172.16/12`, `192.168/16` |
| `into_inner()` | `String` | `"192.168.1.1"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"256.0.0.1"` | `ValidationError::InvalidFormat` |
| `"192.168.001.001"` | `ValidationError::InvalidFormat` (leading zeros) |

---

## IpV6Address

A validated IPv6 address, normalised to canonical compressed lowercase form.

```rust,ignore
use arvo::net::IpV6Address;
use arvo::traits::{PrimitiveValue, ValueObject};

let ip = IpV6Address::new("2001:0db8::0001".into())?;
assert_eq!(ip.value(), "2001:db8::1");

let ip: IpV6Address = "::1".try_into()?;
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"2001:db8::1"` |
| `into_inner()` | `String` | `"2001:db8::1"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"not-an-ip"` | `ValidationError::InvalidFormat` |

---

## IpAddress

A validated IP address — IPv4 or IPv6. Tries IPv4 first, then IPv6.

```rust,ignore
use arvo::net::IpAddress;
use arvo::traits::{PrimitiveValue, ValueObject};

let ip = IpAddress::new("192.168.1.1".into())?;
assert!(ip.is_v4());

let ip = IpAddress::new("::1".into())?;
assert!(ip.is_v6());
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"192.168.1.1"` |
| `is_v4()` | `bool` | `true` |
| `is_v6()` | `bool` | `false` |
| `into_inner()` | `String` | `"192.168.1.1"` |

---

## Port

A validated network port number in the range `1..=65535`. Port 0 is reserved and rejected.

```rust,ignore
use arvo::net::Port;
use arvo::traits::{PrimitiveValue, ValueObject};

let port = Port::new(8080)?;
assert_eq!(*port.value(), 8080);

assert!(Port::new(0).is_err());
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&u16` | `8080` |
| `is_well_known()` | `bool` | `true` for ports 1–1023 |
| `is_registered()` | `bool` | `true` for ports 1024–49151 |
| `is_ephemeral()` | `bool` | `true` for ports 49152–65535 |
| `into_inner()` | `u16` | `8080` |

### Errors

| Input | Error |
|---|---|
| `0` | `ValidationError::InvalidFormat` |

---

## MacAddress

A validated MAC address, normalised to lowercase colon-separated hex. Accepts colon-separated, hyphen-separated, or Cisco dotted formats.

```rust,ignore
use arvo::net::MacAddress;
use arvo::traits::{PrimitiveValue, ValueObject};

let mac = MacAddress::new("AA:BB:CC:DD:EE:FF".into())?;
assert_eq!(mac.value(), "aa:bb:cc:dd:ee:ff");

// Also accepts hyphen and dotted formats
let mac = MacAddress::new("AA-BB-CC-DD-EE-FF".into())?;
let mac = MacAddress::new("AABB.CCDD.EEFF".into())?;
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"aa:bb:cc:dd:ee:ff"` |
| `into_inner()` | `String` | `"aa:bb:cc:dd:ee:ff"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"AA:BB:CC:DD:EE"` | `ValidationError::InvalidFormat` (5 groups) |
| `"GG:BB:CC:DD:EE:FF"` | `ValidationError::InvalidFormat` (invalid hex) |

---

## MimeType

A validated MIME type. Trimmed and lowercased. Parameters (e.g. `; charset=utf-8`) are accepted and preserved.

```rust,ignore
use arvo::net::MimeType;
use arvo::traits::{PrimitiveValue, ValueObject};

let mime = MimeType::new("image/png".into())?;
assert_eq!(mime.value(), "image/png");
assert_eq!(mime.type_part(), "image");
assert_eq!(mime.subtype(), "png");

let mime = MimeType::new("text/html; charset=utf-8".into())?;
assert_eq!(mime.subtype(), "html");
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"image/png"` |
| `type_part()` | `&str` | `"image"` |
| `subtype()` | `&str` | `"png"` |
| `into_inner()` | `String` | `"image/png"` |

### Errors

| Input | Error |
|---|---|
| `""` | `ValidationError::Empty` |
| `"imagepng"` | `ValidationError::InvalidFormat` (no slash) |
| `"image/"` | `ValidationError::InvalidFormat` (empty subtype) |

---

## HttpStatusCode

A validated HTTP status code in the range `100..=599`.

```rust,ignore
use arvo::net::HttpStatusCode;
use arvo::traits::{PrimitiveValue, ValueObject};

let code = HttpStatusCode::new(200)?;
assert!(code.is_success());

let code = HttpStatusCode::new(404)?;
assert!(code.is_client_error());
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&u16` | `200` |
| `is_informational()` | `bool` | `false` |
| `is_success()` | `bool` | `true` |
| `is_redirection()` | `bool` | `false` |
| `is_client_error()` | `bool` | `false` |
| `is_server_error()` | `bool` | `false` |
| `into_inner()` | `u16` | `200` |

### Errors

| Input | Error |
|---|---|
| `< 100` or `> 599` | `ValidationError::InvalidFormat` |

---

## ApiKey

A validated API key — non-empty string. `Display` shows a masked form with only the last 4 characters visible.

```rust,ignore
use arvo::net::ApiKey;
use arvo::traits::{PrimitiveValue, ValueObject};

let key = ApiKey::new("sk-1234567890abcd".into())?;
assert_eq!(key.value(), "sk-1234567890abcd");  // full key
assert_eq!(key.last_four(), "abcd");
println!("{key}");  // *************abcd
```

### Accessors

| Method | Returns | Example |
|---|---|---|
| `value()` | `&String` | `"sk-1234567890abcd"` (full) |
| `last_four()` | `&str` | `"abcd"` |
| `masked()` | `String` | `"*************abcd"` |
| `into_inner()` | `String` | `"sk-1234567890abcd"` |

### Errors

| Input | Error |
|---|---|
| `""` or whitespace only | `ValidationError::Empty` |