waddling-errors 0.7.3

Structured, secure-by-default diagnostic codes for distributed systems with no_std and role-based documentation
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

//! Sequence Number Conventions
//!
//! Following SEQUENCE-CONVENTIONS.md v0.2.0
//!
//! Sequences provide semantic meaning to error codes:
//! - 001-010: Input/Data validation (MISSING, INVALID, etc.)
//! - 011-020: State/Lifecycle (TIMEOUT, STALE, INPROGRESS, etc.)
//! - 021-030: Resource/Storage (NOTFOUND, EXHAUSTED, CORRUPTED, etc.)
//! - 999: Success/Completion

#[cfg(feature = "doc-gen")]
pub fn register_sequences(generator: &mut waddling_errors::doc_generator::DocRegistry) {
    generator
        .register_sequence(
            "MISSING",
            1,
            Some("Required parameter, field, or argument is absent"),
            Some("Error"),
            &[
                "Check if parameter was provided",
                "Verify required fields are set",
            ],
        )
        .register_sequence(
            "MISMATCH",
            2,
            Some("Type or value doesn't match expected format"),
            Some("Error"),
            &["Verify data type", "Check value format"],
        )
        .register_sequence(
            "INVALID",
            3,
            Some("Validation failed - data doesn't meet constraints"),
            Some("Error"),
            &["Review validation rules", "Check input format"],
        )
        .register_sequence(
            "DUPLICATE",
            7,
            Some("Duplicate entry or rate limit violation"),
            Some("Blocked"),
            &["Check for existing entries", "Implement backoff strategy"],
        )
        .register_sequence(
            "DENIED",
            8,
            Some("Access denied - insufficient permissions"),
            Some("Error"),
            &["Verify permissions", "Check authorization"],
        )
        .register_sequence(
            "CANCELLED",
            14,
            Some("Operation cancelled by user or system"),
            Some("Error"),
            &["Check cancellation reason", "Retry if needed"],
        )
        .register_sequence(
            "IN_PROGRESS",
            15,
            Some("Operation still in progress"),
            Some("Blocked"),
            &["Wait for completion", "Check progress status"],
        )
        .register_sequence(
            "TIMEOUT",
            17,
            Some("Operation exceeded time limit"),
            Some("Error"),
            &[
                "Increase timeout",
                "Optimize operation",
                "Check for blocking",
            ],
        )
        .register_sequence(
            "STALE",
            18,
            Some("Data is outdated and needs refresh"),
            Some("Warning"),
            &["Refresh from source", "Adjust TTL settings"],
        )
        .register_sequence(
            "NOT_FOUND",
            21,
            Some("Requested resource does not exist"),
            Some("Error"),
            &[
                "Verify resource identifier",
                "Check if resource was deleted",
            ],
        )
        .register_sequence(
            "ALREADY_EXISTS",
            22,
            Some("Resource already exists - creation conflict"),
            Some("Error"),
            &["Use update instead of create", "Check unique constraints"],
        )
        .register_sequence(
            "CONFLICT",
            23,
            Some("Concurrent modification or version conflict"),
            Some("Error"),
            &["Retry with latest version", "Implement optimistic locking"],
        )
        .register_sequence(
            "CORRUPTED",
            25,
            Some("Data integrity failure - corruption detected"),
            Some("Critical"),
            &[
                "Restore from backup",
                "Verify checksums",
                "Check storage health",
            ],
        )
        .register_sequence(
            "EXHAUSTED",
            26,
            Some("Resource pool or quota completely used"),
            Some("Critical"),
            &[
                "Scale up resources",
                "Implement resource limits",
                "Review capacity planning",
            ],
        )
        .register_sequence(
            "UNAVAILABLE",
            27,
            Some("Service temporarily unavailable"),
            Some("Error"),
            &[
                "Retry after delay",
                "Check service status",
                "Enable fallback",
            ],
        )
        .register_sequence(
            "UNREACHABLE",
            28,
            Some("Network connectivity failure"),
            Some("Error"),
            &["Check network", "Verify endpoint", "Review DNS"],
        )
        .register_sequence(
            "COMPLETE",
            999,
            Some("Operation completed successfully"),
            Some("Success"),
            &["Operation successful", "Check results"],
        );
}