Struct CliError 

pub struct CliError { /* private fields */ }

Typed CLI error with optional remediation hint.

Implementations

impl CliError

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

Create an error without a suggestion.

pub fn with_suggestion( kind: ErrorKind, message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Create an error with a short remediation suggestion for agents.

pub fn with_data(self, data: Value) -> Self

Attach partial JSON data (kept on error envelopes).

pub fn kind(&self) -> ErrorKind

Error category.

pub fn message(&self) -> &str

Human-readable message (also used in JSON error.message).

pub fn suggestion(&self) -> Option<&str>

Optional remediation hint.

pub fn data(&self) -> Option<&Value>

Optional partial data payload.

pub fn exit_code(&self) -> u8

Process exit code for this error.

Trait Implementations

impl Clone for CliError

fn clone(&self) -> CliError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliError

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

Formats the value using the given formatter.

impl Display for CliError

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

Formats the value using the given formatter.

impl Error for CliError

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.