rch-common 1.0.26

Shared types and utilities for Remote Compilation Helper
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

//! Specialized error display components for RCH.
//!
//! This module provides error display components specialized for different
//! error categories. Each component builds on [`super::ErrorPanel`] but adds
//! domain-specific context extraction and formatting.
//!
//! # Components
//!
//! - [`NetworkErrorDisplay`]: SSH and network connectivity errors
//! - [`BuildErrorDisplay`]: Compilation and build errors
//! - [`ConfigErrorDisplay`]: Configuration file and environment errors
//!
//! # Example
//!
//! ```ignore
//! use rch_common::ui::errors::{NetworkErrorDisplay, BuildErrorDisplay, ConfigErrorDisplay};
//! use rch_common::ui::OutputContext;
//!
//! // Network error
//! let display = NetworkErrorDisplay::ssh_connection_failed("build1.internal")
//!     .port(22)
//!     .with_io_error(&io_err)
//!     .network_path("local", "daemon", "worker")
//!     .env_var("SSH_AUTH_SOCK", std::env::var("SSH_AUTH_SOCK").ok());
//!
//! display.render(OutputContext::detect());
//!
//! // Build error
//! let display = BuildErrorDisplay::build_timeout("cargo build --release")
//!     .worker("build1")
//!     .duration_secs(300)
//!     .timeout_secs(300)
//!     .cpu_usage(98.0)
//!     .memory_usage(14.2, 16.0);
//!
//! display.render(OutputContext::detect());
//!
//! // Config error
//! let display = ConfigErrorDisplay::parse_error("/home/user/.config/rch/config.toml")
//!     .line(13)
//!     .column(15)
//!     .snippet("timeout = \"thirty\"")
//!     .expected("integer")
//!     .actual("string");
//!
//! display.render(OutputContext::detect());
//! ```

pub mod build;
pub mod config;
pub mod network;

pub use build::{BuildErrorDisplay, SignalInfo, WorkerResourceState};
pub use config::{
    ConfigErrorDisplay, ConfigLocation, ConfigSearchPaths, ConfigSnippet, TypeMismatch,
};
pub use network::NetworkErrorDisplay;