Struct CliError 

pub struct CliError {
    pub error_type: String,
    pub title: String,
    pub detail: String,
    pub suggestion: Option<String>,
    pub docs_url: Option<String>,
    pub context: HashMap<String, Value>,
    pub exit_code: i32,
}

Structured error following RFC 9457 (Problem Details) style.

Provides machine-readable error information with human-friendly presentation.

Fields

error_type: String

Error type identifier (machine-readable).

title: String

Short human-readable title.

detail: String

Detailed explanation.

suggestion: Option<String>

Suggested action for recovery.

docs_url: Option<String>

Related documentation URL.

context: HashMap<String, Value>

Additional context (varies by error type).

exit_code: i32

Exit code for this error.

Implementations

impl CliError

pub fn new(error_type: impl Into<String>, title: impl Into<String>) -> Self

Create a new CLI error.

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

Add detailed explanation.

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

Add a suggested recovery action.

pub fn docs(self, url: impl Into<String>) -> Self

Add documentation URL.

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

Add context field.

pub const fn exit_code(self, code: i32) -> Self

Set exit code.

pub fn human_format(&self, color: bool) -> String

Format for human output.

When color is true, includes ANSI escape codes for terminal coloring.

pub fn json_format(&self) -> String

Format as JSON.

pub fn json_pretty_format(&self) -> String

Format as pretty JSON.

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<'de> Deserialize<'de> for CliError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

impl Serialize for CliError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.