Enum Diagnostic 

pub enum Diagnostic {
    Usage(String),
    AuthRequired(String),
    NotFound(String),
    ServerError(String),
    Network(String),
    Conflict(String),
    Io(String),
    Internal(String),
    NotImplemented(String),
}

Library error type. Stable enum variants per ADR-0012.

Clone is derived so that mock test helpers can hand out Result<_, Diagnostic> values repeatedly without consuming them. All current variants hold String, which is Clone.

Variants

Usage(String)

Bad input from the caller — bad flag, missing argument, unparseable id.

AuthRequired(String)

The server demanded auth and none was supplied (or the token was rejected).

NotFound(String)

The named project / data-model / resource-type does not exist.

ServerError(String)

The server responded with a 5xx or an unparseable response.

Network(String)

Could not reach the server.

Conflict(String)

A server-side resource is busy or already exists.

Examples: a dump for this project is already in progress or present; a DELETE was attempted while the dump was still being produced.

Maps to ExitCategory::Runtime (exit code 1).

Io(String)

A local filesystem operation that the user explicitly requested failed.

Example: writing or renaming the dump file the user asked for.

Distinction from Internal: Internal wraps unexpected internal I/O (renderer writes, plumbing) and is reached via the blanket From<std::io::Error> impl. Io is for user-visible filesystem work (e.g. writing the dump output file) and must be constructed explicitly with a message that includes the target path.

Warning: the dump file-write path must never use bare ? on a std::io::Error. Bare ? will hit From<io::Error> and mis-classify the error as Internal instead of Io. Always map explicitly: .map_err(|e| Diagnostic::Io(format!("…{path}…: {e}"))). See the scoped helper stream_dump_to_path in the action (Step 8).

Maps to ExitCategory::Runtime (exit code 1).

Internal(String)

Unexpected state in dsp-cli itself; should be reported as a bug.

NotImplemented(String)

Placeholder for work-in-progress dispatch paths during Phase 1.

Implementations

impl Diagnostic

pub fn not_implemented(msg: impl Into<String>) -> Self

pub fn exit_category(&self) -> ExitCategory

Maps a diagnostic to its exit category (per ADR-0012).

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl Error for Diagnostic

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<Error> for Diagnostic

Bridge from std::io::Error so that ? works inside renderer methods (and any other function returning Result<_, Diagnostic>) without spelling out .map_err(|e| Diagnostic::Internal(...)) at every call site.

fn from(e: Error) -> Self

Converts to this type from the input type.