waddling-errors-hash 0.7.2

Compact xxHash3-based error code hashing for network-efficient diagnostics in distributed systems
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

# 🦆 waddling-errors-hash


WDP-compliant xxHash3 computation for diagnostic codes.

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

---

## What It Does


Converts error codes to compact 5-character hashes per [WDP Part 5](https://gitlab.com/AshutoshMahala/wdp-specs/-/blob/main/5-COMPACT-IDS.md).

```rust
use waddling_errors_hash::compute_wdp_hash;

let hash = compute_wdp_hash("E.Auth.Token.001");
// Returns 5-char base62 hash, e.g., "V6a0B"

// Case-insensitive (WDP normalization):
assert_eq!(
    compute_wdp_hash("E.Auth.Token.001"),
    compute_wdp_hash("e.auth.token.001")
);
```

---

## Installation


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

---

## API


### WDP-Conformant (Recommended)


```rust
use waddling_errors_hash::{
    compute_wdp_hash,           // Hash error code
    compute_wdp_namespace_hash, // Hash namespace
    compute_wdp_full_id,        // "ns_hash-code_hash"
};

let code_hash = compute_wdp_hash("E.Auth.Token.001");       // "V6a0B"
let ns_hash = compute_wdp_namespace_hash("auth_lib");       // "05o5h"
let full_id = compute_wdp_full_id("auth_lib", "E.Auth.Token.001"); // "05o5h-V6a0B"
```

### Custom Seed


```rust
use waddling_errors_hash::{compute_hash_with_config, HashConfig};

let config = HashConfig::with_seed(0x1234567890ABCDEF);
let hash = compute_hash_with_config("E.Auth.Token.001", &config);
```

---

## WDP Seeds


| Purpose | Seed | u64 Value |
|---------|------|-----------|
| Error codes | `"wdp-v1"` | `0x000031762D706477` |
| Namespaces | `"wdpns-v1"` | `0x31762D736E706477` |

---

## Cross-Language


Same algorithm works in Python, JS, Go, etc:

```python
import xxhash
WDP_SEED = 0x000031762D706477
hash_value = xxhash.xxh3_64(input_bytes, seed=WDP_SEED)
```

---

## Security Note


xxHash3 is NOT cryptographically secure. It's designed for speed and distribution quality. Use TLS/JWT for security requirements.

---

## Documentation


- [WDP Part 5: Compact IDs](https://gitlab.com/AshutoshMahala/wdp-specs/-/blob/main/5-COMPACT-IDS.md)
- [WDP Part 7: Namespaces](https://gitlab.com/AshutoshMahala/wdp-specs/-/blob/main/7-NAMESPACES.md)
- [API Reference](https://docs.rs/waddling-errors-hash)

---

## License


MIT or Apache-2.0.