Enum ControlErrorCode 

#[non_exhaustive]
pub enum ControlErrorCode {
    ParseError,
    InvalidRequest,
    MethodNotFound,
    InvalidParams,
    DispatchFailed,
    Unauthorized,
    NotSupported,
    ControlError,
}

A canonical control-plane error code.

#[non_exhaustive] so adding a code in a minor release is additive; downstream matches must use a _ => … arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ParseError

-32700 — request body was not valid JSON.

InvalidRequest

-32600 — the request was not a single JSON-RPC object (batches are unsupported).

MethodNotFound

-32601 — the control method is not resolved by the node.

InvalidParams

-32602 — invalid or missing method parameters.

DispatchFailed

-32000 — the node failed to dispatch a well-formed control call.

Unauthorized

-32030 — a control.* method was called without a valid local control token.

NotSupported

-32031 — the control operation is not supported on this node build (e.g. §21 sync with no identity loaded, or a capability the running engine does not expose).

ControlError

-32032 — a control operation failed at runtime (e.g. a config write or cache op errored).

Implementations

impl ControlErrorCode

pub const ALL: &'static [ControlErrorCode]

Every catalogued code, for the error-catalogue document + drift tests.

pub const fn code(self) -> i64

The numeric JSON-RPC error code.

pub const fn name(self) -> &'static str

The stable UPPER_SNAKE symbolic name a client branches on. Never derived from the message.

pub const fn origin(self) -> &'static str

Where the error originates, mirroring dig-node’s classification.

pub const fn description(self) -> &'static str

A one-line description for the error catalogue.

pub fn from_code(code: i64) -> Option<ControlErrorCode>

Resolve a numeric wire code back to its variant, or None for an uncatalogued code.

Trait Implementations

impl Clone for ControlErrorCode

fn clone(&self) -> ControlErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ControlErrorCode

impl Debug for ControlErrorCode

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

Formats the value using the given formatter.

impl Eq for ControlErrorCode

impl Hash for ControlErrorCode

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ControlErrorCode