Struct exonum_api::Error

#[non_exhaustive]pub struct Error {
    pub http_code: HttpStatusCode,
    pub body: ErrorBody,
    pub headers: HeaderMap,
}

API HTTP error struct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

http_code: HttpStatusCode

HTTP error code.

body: ErrorBody

API error body.

headers: HeaderMap

Additional HTTP headers.

Methods

impl Error

pub fn new(http_code: HttpStatusCode) -> Self

Builds a ApiError with the given http_code.

pub fn bad_request() -> Self

Builds Bad Request (400) error.

pub fn forbidden() -> Self

Builds Forbidden (403) error.

pub fn not_found() -> Self

Builds Not Found (404) error.

pub fn internal(cause: impl Display) -> Self

Builds Internal Server Error (500).

pub fn docs_uri(self, docs_uri: impl Into<String>) -> Self

Sets docs_uri of an error.

pub fn title(self, title: impl Into<String>) -> Self

Sets title of an error.

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

Sets detail of an error.

pub fn error_code(self, error_code: u8) -> Self

Sets error_code of an error.

pub fn parse(http_code: HttpStatusCode, body: &str) -> Result<Self, Error>

Tries to create ApiError from JSON.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Default for Error

fn default() -> Self

Returns the "default value" for a type.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<MovedPermanentlyError> for Error

fn from(e: MovedPermanentlyError) -> Self

Performs the conversion.

impl ResponseError for ApiError

fn error_response(&self) -> HttpResponse

Create response for error

fn status_code(&self) -> StatusCode

Response's status code