Skip to main content

rch_common/errors/
mod.rs

1//! Error catalog and definitions for Remote Compilation Helper
2//!
3//! This module provides a comprehensive error catalog with unique error codes,
4//! categorized by subsystem. Each error includes remediation steps and
5//! documentation links.
6//!
7//! # Error Code Ranges
8//!
9//! | Range      | Category    | Description                          |
10//! |------------|-------------|--------------------------------------|
11//! | E001-E099  | Config      | Configuration and setup errors       |
12//! | E013-E018  |   PathDeps  |   Path-dependency resolution errors  |
13//! | E019-E024  |   Closure   |   Dependency-closure planner errors  |
14//! | E100-E199  | Network     | Network and SSH connectivity         |
15//! | E200-E299  | Worker      | Worker selection and management      |
16//! | E210-E219  |   Storage   |   Disk pressure and storage errors   |
17//! | E300-E399  | Build       | Compilation and build errors         |
18//! | E310-E319  |   Triage    |   Process triage integration errors  |
19//! | E400-E499  | Transfer    | File transfer and sync errors        |
20//! | E500-E599  | Internal    | Internal/unexpected errors           |
21//!
22//! Reliability-doctor reason codes use a separate `RCH-Rnnn` namespace; see
23//! [`reliability`] for the full table.
24
25pub mod catalog;
26pub mod explain;
27pub mod reliability;
28
29pub use catalog::{ErrorCategory, ErrorCode, ErrorEntry};
30pub use explain::{
31    CodeExplanation, CodeNamespace, is_known, is_known_category, known_categories, list_all,
32    list_by_category, lookup, render_human,
33};
34pub use reliability::{ReliabilityCategoryKind, ReliabilityReasonCode};