Enum DebtmapError 

pub enum DebtmapError {
    Io {
        code: ErrorCode,
        message: String,
        path: Option<PathBuf>,
        source: Option<Arc<Error>>,
    },
    Parse {
        code: ErrorCode,
        message: String,
        path: PathBuf,
        line: Option<usize>,
        column: Option<usize>,
    },
    Config {
        code: ErrorCode,
        message: String,
        field: Option<String>,
        path: Option<PathBuf>,
    },
    Analysis {
        code: ErrorCode,
        message: String,
        phase: Option<AnalysisPhase>,
    },
    Cli {
        code: ErrorCode,
        message: String,
        arg: Option<String>,
    },
    Validation {
        code: ErrorCode,
        count: usize,
        errors: Vec<String>,
    },
}

Unified error type for debtmap operations.

This enum consolidates all error types across the codebase into a single, well-structured type with error codes, classification methods, and context.

Variants

Io

I/O and filesystem errors.

Fields

code: ErrorCode

Error code for documentation lookup.

message: String

Human-readable error message.

path: Option<PathBuf>

Associated file path, if any.

source: Option<Arc<Error>>

Source error for debugging.

Parse

Source code parsing errors.

Fields

code: ErrorCode

Error code for documentation lookup.

message: String

Human-readable error message.

path: PathBuf

File being parsed.

line: Option<usize>

Line number where error occurred.

column: Option<usize>

Column number where error occurred.

Config

Configuration errors.

Fields

code: ErrorCode

Error code for documentation lookup.

message: String

Human-readable error message.

field: Option<String>

Configuration field name, if applicable.

path: Option<PathBuf>

Configuration file path, if applicable.

Analysis

Analysis execution errors.

Fields

code: ErrorCode

Error code for documentation lookup.

message: String

Human-readable error message.

phase: Option<AnalysisPhase>

Analysis phase where error occurred.

Cli

CLI argument errors.

Fields

code: ErrorCode

Error code for documentation lookup.

message: String

Human-readable error message.

arg: Option<String>

Argument name, if applicable.

Validation

Validation errors (may contain multiple issues).

Fields

code: ErrorCode

Error code for documentation lookup.

count: usize

Number of validation errors.

errors: Vec<String>

Individual error messages.

Implementations

impl DebtmapError

pub fn io(message: impl Into<String>, path: Option<PathBuf>) -> Self

Create an I/O error with a message and optional path.

pub fn from_io_error(err: Error, path: Option<PathBuf>) -> Self

Create an I/O error from a std::io::Error.

pub fn parse( message: impl Into<String>, path: impl Into<PathBuf>, line: Option<usize>, column: Option<usize>, ) -> Self

Create a parse error with context.

pub fn parse_syntax( message: impl Into<String>, path: impl Into<PathBuf>, line: Option<usize>, column: Option<usize>, ) -> Self

Create a parse error with syntax error code.

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

Create a configuration error.

pub fn config_with_field( message: impl Into<String>, field: impl Into<String>, ) -> Self

Create a configuration error with field context.

pub fn config_with_path( message: impl Into<String>, path: impl Into<PathBuf>, ) -> Self

Create a configuration error with path context.

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

Create an analysis error.

pub fn analysis_with_phase( message: impl Into<String>, phase: AnalysisPhase, ) -> Self

Create an analysis error with phase context.

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

Create a CLI error.

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

Create a CLI error for invalid command.

pub fn cli_missing_arg(arg: impl Into<String>) -> Self

Create a CLI error for missing argument.

pub fn cli_invalid_arg( arg: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a CLI error for invalid argument.

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

Create a validation error with a single message.

pub fn validations(errors: Vec<String>) -> Self

Create a validation error with multiple messages.

pub fn code(&self) -> ErrorCode

Get the error code.

pub fn category(&self) -> &'static str

Get the error category name.

pub fn message(&self) -> &str

Get the error message.

pub fn path(&self) -> Option<&PathBuf>

Get the associated path, if any.

pub fn is_retryable(&self) -> bool

Check if this error is potentially transient and retryable.

Retryable errors are those that might succeed on a subsequent attempt:

• Resource busy / file locks
• Network timeouts
• Coverage loading (external tool issues)

Non-retryable errors include:

• Parse/syntax errors
• Configuration errors
• Validation errors
• File not found (permanent)

pub fn is_user_fixable(&self) -> bool

Check if this error is something the user can fix.

User-fixable errors include:

• Configuration errors (fix config file)
• CLI errors (fix command arguments)
• Validation errors (fix input)
• Parse errors (fix source code)

Non-user-fixable errors include:

• I/O errors (system issues)
• Analysis errors (internal algorithm issues)

pub fn exit_code(&self) -> i32

Get the suggested exit code for this error.

Trait Implementations

impl Clone for DebtmapError

fn clone(&self) -> DebtmapError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebtmapError

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

Formats the value using the given formatter.

impl Display for DebtmapError

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

Formats the value using the given formatter.

impl Error for DebtmapError

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 From<AnalysisError> for DebtmapError

fn from(err: AnalysisError) -> Self

Converts to this type from the input type.

impl From<AnalysisError> for DebtmapError

fn from(err: AnalysisError) -> Self

Converts to this type from the input type.

impl From<AppError> for DebtmapError

fn from(err: AppError) -> Self

Converts to this type from the input type.

impl From<CliError> for DebtmapError

fn from(err: CliError) -> Self

Converts to this type from the input type.

impl From<ConfigError> for DebtmapError

fn from(err: ConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for DebtmapError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DebtmapError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DebtmapError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl Serialize for DebtmapError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.