Skip to main content

Module catalog

Module catalog 

Source
Expand description

Error Catalog for Remote Compilation Helper

This module defines a comprehensive error catalog with unique error codes, categorized by subsystem. Each error includes:

  • A unique code (RCH-E001 through RCH-E999)
  • A human-readable message template
  • Remediation steps
  • Documentation links where applicable

§Error Code Ranges

RangeCategoryDescription
E001-E099ConfigConfiguration and setup errors
E100-E199NetworkNetwork and SSH connectivity
E200-E299WorkerWorker selection and management
E300-E399BuildCompilation and build errors
E400-E499TransferFile transfer and sync errors
E500-E599InternalInternal/unexpected errors

§Extended Sub-Ranges (within existing categories)

RangeSubcategoryDescription
E013-E018Config/PathDepsPath-dependency resolution errors
E019-E024Config/ClosureDependency-closure planner errors
E210-E219Worker/StorageDisk pressure and storage errors
E310-E319Build/TriageProcess triage integration errors
E320-E325Build/CancellationBuild cancellation lifecycle errors

§Example

use rch_common::errors::catalog::{ErrorCode, ErrorEntry};

let error = ErrorCode::ConfigNotFound;
let entry = error.entry();

println!("Error {}: {}", entry.code, entry.message);
for step in entry.remediation {
    println!("  - {}", step);
}

Structs§

ErrorEntry
Complete error entry with all metadata.

Enums§

ErrorCategory
Error category for grouping related errors.
ErrorCode
Error code enumeration covering all RCH error scenarios.