Struct ApiError 

pub struct ApiError {
    pub status: u16,
    pub code: ErrorCode,
    pub message: String,
    pub details: Option<Value>,
}

Core’s error envelope plus the HTTP status it came with.

Fields

status: u16

HTTP status of the response (401, 403, 404, 409, 422, …).

code: ErrorCode

Machine-readable error.code; match on this, not on the message.

message: String

Human-readable error.message, as Core wrote it.

details: Option<Value>

Structured detail, e.g. the list of violated zone rules on 409/422.

Implementations

impl ApiError

pub fn managed(&self) -> Option<(&str, &str)>

For ErrorCode::ManagedRecord and ErrorCode::ManagedCertificate: who keeps the resource (Redirect, Acme) and the name it is kept for (the redirect’s host name). None for other errors.

pub fn import_report(&self) -> Option<ImportReport>

For ErrorCode::ImportFailed: the import report Core sends in details (which records were refused and why). None for other errors, or if details does not have the report’s shape.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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<ApiError> for Error

fn from(source: ApiError) -> Self

Converts to this type from the input type.