Struct ConfigApiError 

pub struct ConfigApiError {
    pub code: ConfigApiCode,
    pub message: String,
    pub path: Option<String>,
    pub op_index: Option<usize>,
}

Structured error returned by the new HTTP CRUD endpoints and the zeroclaw config subcommands they share infrastructure with.

Fields

code: ConfigApiCode

Stable error code for programmatic matching.

message: String

Human-readable message. Safe to render directly in dashboards / terminals.

path: Option<String>

Property path the error pertains to, when applicable. Empty when the error is whole-config (e.g. ReloadFailed).

op_index: Option<usize>

Index into the JSON Patch operation array, when the error originated from a specific op in a PATCH /api/config batch.

Implementations

impl ConfigApiError

pub fn new(code: ConfigApiCode, message: impl Into<String>) -> Self

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

pub fn with_op_index(self, index: usize) -> Self

pub fn from_validation(err: Error) -> Self

impl ConfigApiError

pub fn path_not_found(path: impl Into<String>) -> Self

Convenience: a path_not_found error for the given path.

pub fn secret_test_forbidden(path: impl Into<String>) -> Self

Convenience: a secret_test_forbidden error for the given path.

pub fn op_not_supported(op: impl Into<String>) -> Self

Convenience: an op_not_supported error.

Trait Implementations

impl Clone for ConfigApiError

fn clone(&self) -> ConfigApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigApiError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ConfigApiError

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

Formats the value using the given formatter.

impl Error for ConfigApiError

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 JsonSchema for ConfigApiError

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ConfigApiError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.