Struct ApiError 

pub struct ApiError {
    pub code: String,
    pub category: ErrorCategory,
    pub message: String,
    pub details: Option<String>,
    pub remediation: Vec<String>,
    pub context: ErrorContext,
    pub retry_after_secs: Option<u64>,
}

Unified API error structure.

This type is used for all error responses in both CLI and daemon APIs. It uses the ErrorCode enum for consistent error identification.

Example

use rch_common::api::ApiError;
use rch_common::ErrorCode;

let error = ApiError::from_code(ErrorCode::SshConnectionFailed)
    .with_message("Connection refused")
    .with_context("worker_id", "worker-1")
    .with_context("host", "192.168.1.100");

assert_eq!(error.code, "RCH-E100");

Fields

code: String

Error code in RCH-Exxx format (e.g., “RCH-E100”).

category: ErrorCategory

Error category for quick classification.

message: String

Human-readable error message.

details: Option<String>

Detailed description of what went wrong.

remediation: Vec<String>

Suggested remediation steps.

context: ErrorContext

Additional context information.

retry_after_secs: Option<u64>

Optional retry-after hint in seconds (for rate limiting).

Implementations

impl ApiError

pub fn from_code(code: ErrorCode) -> Self

Create an ApiError from an ErrorCode.

Automatically populates the code string, category, message, and remediation from the error catalog.

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Create an ApiError with a custom message.

pub fn with_message(self, message: impl Into<String>) -> Self

Add or replace the detailed message.

pub fn with_details(self, details: impl Into<String>) -> Self

Alias for with_message for clarity.

pub fn with_context( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a context field.

pub fn with_context_map(self, map: HashMap<String, String>) -> Self

Add multiple context fields.

pub fn with_retry_after(self, seconds: u64) -> Self

Set retry-after hint for rate limiting errors.

pub fn with_remediation( self, steps: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add additional remediation steps.

pub fn internal(message: impl Into<String>) -> Self

Create a generic internal error.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl JsonSchema for ApiError

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ApiError

fn eq(&self, other: &ApiError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ApiError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiError