Struct ApiError 

pub struct ApiError {
    pub kind: ErrorKind,
    pub message: String,
}

One folded method’s failure.

Why: the handlers below return Result<Value, ApiError> rather than Result<Value, RpcError> so the code mapping lives in one place instead of at every return. That is the shape trusty-analyze’s ApiError took through the same migration. What: a kind and a message. The message reaches the caller verbatim. Test: api_error_message_survives_the_conversion.

Fields

kind: ErrorKind

Which failure this is.

message: String

What to tell the caller.

Implementations

impl ApiError

pub fn bad_request(msg: impl Into<String>) -> Self

The caller’s arguments are wrong.

pub fn not_found(msg: impl Into<String>) -> Self

The thing named is not there.

pub fn conflict(msg: impl Into<String>) -> Self

Understood, and refused. Formerly 409 Conflict.

pub fn forbidden(msg: impl Into<String>) -> Self

Understood, and denied. Formerly 403 Forbidden (#1714).

pub fn unprocessable(msg: impl Into<String>) -> Self

Structurally valid and semantically unacceptable — content too short to be worth storing (#466). Formerly 422.

pub fn internal(msg: impl Into<String>) -> Self

The daemon could not complete the call.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

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, f: &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 RpcError

The one place a failure kind becomes a JSON-RPC code (#6286).

Every folded method’s ? runs through here, so a change to the mapping is a change to the whole surface rather than to whichever handler was edited last.

Test: api_error_kind_maps_to_its_rpc_code.

fn from(e: ApiError) -> Self

Converts to this type from the input type.

impl From<ServiceError> for ApiError

fn from(e: ServiceError) -> Self

Converts to this type from the input type.