rcp-tools-common 0.33.0

Internal library for RCP file operation tools - shared utilities and core operations (not intended for direct use)
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

//! Generic error type for tree-walking operations that preserves the partial
//! summary (work that completed before the error) alongside the error chain.
//!
//! Each operation (copy, link, rm, filegen) wraps this with a per-operation
//! `Summary` via a type alias.
//!
//! # Logging Convention
//! When logging this error, use `{:#}` or `{:?}` format to preserve the error chain:
//! ```ignore
//! tracing::error!("operation failed: {:#}", &error); // ✅ Shows full chain
//! tracing::error!("operation failed: {:?}", &error); // ✅ Shows full chain
//! ```
//! The Display implementation also shows the full chain, but workspace linting enforces `{:#}`
//! for consistency.

#[derive(Debug, thiserror::Error)]
#[error("{source:#}")]
pub struct OperationError<S> {
    #[source]
    pub source: anyhow::Error,
    pub summary: S,
}

impl<S> OperationError<S> {
    #[must_use]
    pub fn new(source: anyhow::Error, summary: S) -> Self {
        OperationError { source, summary }
    }
}