Enum ControlPlaneClientError 

pub enum ControlPlaneClientError {
    Unreachable {
        url: String,
        source: Error,
    },
    Unauthorized,
    NotFound(AgentId),
    Unsupported(String),
    Api {
        status: StatusCode,
        message: String,
    },
    Malformed(Error),
}

Why a control-plane call failed.

The distinctions are the ones a caller acts on differently: a bad token is fixed by the operator, a missing agent by naming another one, an unreachable URL by starting the control plane — and everything else is the control plane’s own diagnosis, which is worth passing through verbatim (it is where “line 4: unknown key http_prot” and “references env vars that are not allowed” come from).

Variants

Unreachable

The control plane could not be reached at all.

Fields

url: String

The base URL that was dialled.

source: Error

The underlying transport error.

Unauthorized

The request was rejected for want of a valid bearer token.

NotFound(AgentId)

No agent with that id is deployed.

Unsupported(String)

This control plane cannot serve the request — e.g. logs from a runtime that does not capture them.

Api

The control plane refused or failed the request, and said why.

Fields

status: StatusCode

The HTTP status it answered with.

message: String

Its own description of the failure.

Malformed(Error)

A response arrived but was not the shape this client expects.

Trait Implementations

impl Debug for ControlPlaneClientError

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

Formats the value using the given formatter.

impl Display for ControlPlaneClientError

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

Formats the value using the given formatter.

impl Error for ControlPlaneClientError

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.