Struct interledger_http::error::ApiError

pub struct ApiError {
    pub type: &'static ProblemType,
    pub title: &'static str,
    pub status: StatusCode,
    pub detail: Option<String>,
    pub instance: Option<String>,
    pub extension_members: Option<Map<String, Value>>,
}

This struct represents the fields defined in RFC7807. The meaning of each field could be found at Members of a Problem Details Object section. ApiError implements Reply so that it could be used for responses.

Fields

type: &'static ProblemType

type is a URI which represents an error type. The URI should provide human-readable documents so that developers can solve the problem easily.

title: &'static str

title is a short, human-readable summary of the type. SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status: StatusCode

status is a HTTP status of the problem.

detail: Option<String>

detail explains the problem in human-readable detail.

instance: Option<String>

instance is a URI reference that identifies the specific occurrence of the problem. We should be careful of how we provide the URI because if it provides very detailed information about the error, it might expose some vulnerabilities of the node.

extension_members: Option<Map<String, Value>>

extension_members is a Map of JSON values which will be flatly injected into response JSONs. For example, if we specify extension_members like:

"invalid-params": [
    { "name": "Username", "type": "missing" }
]

then this map is merged into the response JSON and will look like:

{
    "type": "about:blank",
    "title": "Missing Fields Error",
    "status": 400,
    "detail": "foo bar",
    "invalid-params": [
        { "name": "Username", "type": "missing" }
    ]
}

Methods

impl ApiError

pub fn from_api_error_type(problem_type: &ApiErrorType) -> Self

pub fn bad_request() -> Self

pub fn internal_server_error() -> Self

pub fn unauthorized() -> Self

pub fn not_found() -> Self

pub fn method_not_allowed() -> Self

pub fn account_not_found() -> Self

pub fn idempotency_conflict() -> Self

pub fn invalid_account_id(invalid_account_id: Option<&str>) -> Self

pub fn invalid_ilp_packet() -> Self

pub fn detail<T>(self, detail: T) -> Self where
    T: Into<String>, 

pub fn instance<T>(self, instance: T) -> Self where
    T: Into<String>, 

pub fn extension_members(
    self,
    extension_members: Option<Map<String, Value>>
) -> Self

Trait Implementations

impl From<ApiError> for Rejection

fn from(from: ApiError) -> Self

Performs the conversion.

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error ocurred.

impl Serialize for ApiError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Reply for ApiError

fn into_response(self) -> Response

Converts the given value into a [Response].