Enum MisarDevError 

pub enum MisarDevError {
    Validation(ApiError),
    Authentication(ApiError),
    PermissionDenied(ApiError),
    NotFound(ApiError),
    Conflict(ApiError),
    RateLimit(Box<RateLimitError>),
    Server(ApiError),
    PlanLimit(Box<PlanLimitError>),
    Api(ApiError),
    Network {
        message: String,
        source: Option<Error>,
    },
    MissingApiKey,
    Config(String),
}

Every error the SDK returns.

Variants

Validation(ApiError)

400 / 422 — the request was malformed or failed validation.

Authentication(ApiError)

401 — the key is missing, revoked, expired, or not a MisarDev key.

PermissionDenied(ApiError)

403 — authenticated, but not allowed to touch this resource.

NotFound(ApiError)

404 — no such resource, or not one this key can see.

Conflict(ApiError)

409 — conflicts with current state (e.g. a build already running).

RateLimit(Box<RateLimitError>)

429 that is an ordinary throttle, after the client already retried it.

Server(ApiError)

5xx — the API failed. Retried automatically for idempotent requests.

PlanLimit(Box<PlanLimitError>)

The plan behind the key does not cover this call. Never retried.

Api(ApiError)

Any other non-2xx status.

Network

The request never got an HTTP answer (DNS, TLS, reset, timeout). Status 0.

Fields

message: String

source: Option<Error>

MissingApiKey

No API key was passed and MISARDEV_API_KEY is unset.

Config(String)

The client could not be configured (e.g. the HTTP client failed to build).

Implementations

impl MisarDevError

pub fn api_error(&self) -> Option<&ApiError>

The shared fields, when this is an HTTP error.

pub fn status(&self) -> u16

HTTP status, or 0 when there was no HTTP answer.

pub fn message(&self) -> String

Human-readable message.

pub fn code(&self) -> Option<&str>

Machine-readable code from the body, when sent.

pub fn body(&self) -> Option<&Value>

The decoded error body.

pub fn request_id(&self) -> Option<&str>

The x-request-id header.

pub fn rate_limit(&self) -> Option<&RateLimitError>

The throttle details, when this is an ordinary rate limit.

pub fn plan_limit(&self) -> Option<&PlanLimitError>

The plan-limit details, when this is a plan refusal.

pub fn is_retryable(&self) -> bool

Worth retrying as-is: a throttle or a transient server condition.

Trait Implementations

impl Debug for MisarDevError

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

Formats the value using the given formatter.

impl Display for MisarDevError

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

Formats the value using the given formatter.

impl Error for MisarDevError

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 From<Error> for MisarDevError

fn from(e: Error) -> Self

Converts to this type from the input type.