Struct EndpointError 

pub struct EndpointError {
    pub status: u16,
    pub code: String,
    pub message: String,
}

Error response returned by a handler.

CCF sends an OData JSON error with this code and message, which are visible to the client and may be empty. A status that is not a known HTTP status of 400 or above is sent as HTTP 500.

use ccf_app::EndpointError;

let error = EndpointError::new(404, "ResourceNotFound", "No such key");
assert_eq!(error.status, 404);

Fields

status: u16

HTTP status.

code: String

Error code, such as "ResourceNotFound".

message: String

Error message.

Implementations

impl EndpointError

pub fn new( status: u16, code: impl Into<String>, message: impl Into<String>, ) -> Self

Create an error. The status is only checked when the response is sent.

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

Create an HTTP 500 error with code "InternalError".

Trait Implementations

impl Clone for EndpointError

fn clone(&self) -> EndpointError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointError

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

Formats the value using the given formatter.

impl From<BridgeError> for EndpointError

Convert to an HTTP 500 InternalError, so that ? can be used in handlers.

use ccf_app::{BridgeError, EndpointError};

let error = EndpointError::from(BridgeError::InvalidArgument);
assert_eq!(error.status, 500);
assert_eq!(error.message, "CCF bridge error: InvalidArgument");

fn from(error: BridgeError) -> Self

Converts to this type from the input type.