Enum ConfigApiCode 

pub enum ConfigApiCode {
    PathNotFound,
    ValidationFailed,
    ConfigChangedExternally,
    ReloadFailed,
    OpNotSupported,
    SecretTestForbidden,
    ValueTypeMismatch,
    RequiredFieldEmpty,
    InvalidNumericRange,
    InvalidFormat,
    InvalidEnumVariant,
    DanglingReference,
    InternalError,
}

Stable error code consumed by HTTP / CLI / dashboard. Add codes here as new failure cases land — never invent codes ad-hoc at call sites.

Variants

PathNotFound

The supplied property path is not defined in the schema.

ValidationFailed

Generic schema validation failure (catch-all wrapping Config::validate() bails).

ConfigChangedExternally

On-disk config differs from in-memory state (an out-of-band file edit happened despite the daemon-running rule). Caller should reload.

ReloadFailed

The daemon-reload step after a successful save failed; on-disk config has been reverted to the pre-write snapshot to keep state consistent.

OpNotSupported

JSON Patch operation type is not supported (move / copy).

SecretTestForbidden

JSON Patch test operation targeted a secret or derived-from-secret path; rejected to prevent differential value inference.

ValueTypeMismatch

The supplied JSON value does not match the field’s declared type (e.g. an array passed where a scalar was expected, or a non-string element in a Vec<String>).

RequiredFieldEmpty

A required scalar field was empty / missing / blank. Path identifies which one (e.g. gateway.host, tunnel.openvpn.config_file).

InvalidNumericRange

A numeric field was out of its allowed range (zero, negative, or above an upper bound). Path identifies which one.

InvalidFormat

A string did not match its allowed format — invalid URL, bad scheme, invalid path prefix, characters outside the allowed set.

InvalidEnumVariant

An enum / discriminator field carried a value not in the allowed set (e.g. tunnel.tunnel_provider with an unknown name).

DanglingReference

A reference to another config entry pointed at something that doesn’t exist (e.g. agents.<x>.delegate_to naming a missing agent).

InternalError

Catch-all server failure not classified above. Avoid in code; log the original error and convert to a more specific code where possible.

Implementations

impl ConfigApiCode

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

pub fn http_status(self) -> u16

HTTP status that the gateway returns when this code is the response.

Trait Implementations

impl Clone for ConfigApiCode

fn clone(&self) -> ConfigApiCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConfigApiCode

impl Debug for ConfigApiCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigApiCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigApiCode

impl Hash for ConfigApiCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ConfigApiCode

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 PartialEq for ConfigApiCode

fn eq(&self, other: &ConfigApiCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConfigApiCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigApiCode