Trait edm_core::response::ResponseCode

pub trait ResponseCode {
    type ErrorCode: Serialize;
    type BusinessCode: Serialize;

    const OK: Self;
    const BAD_REQUEST: Self;
    const INTERNAL_SERVER_ERROR: Self;

    // Required methods
    fn status_code(&self) -> u16;
    fn is_success(&self) -> bool;

    // Provided methods
    fn error_code(&self) -> Option<Self::ErrorCode> { ... }
    fn business_code(&self) -> Option<Self::BusinessCode> { ... }
    fn type_uri(&self) -> Option<SharedString> { ... }
    fn title(&self) -> Option<SharedString> { ... }
    fn message(&self) -> Option<SharedString> { ... }
}

Trait for response code. See Problem Details for HTTP APIs.

Required Associated Types

type ErrorCode: Serialize

A type for the error code.

type BusinessCode: Serialize

A type for the business code.

Required Associated Constants

const OK: Self

200 Ok.

const BAD_REQUEST: Self

400 Bad Request.

const INTERNAL_SERVER_ERROR: Self

500 Internal Server Error.

Required Methods

fn status_code(&self) -> u16

Status code.

fn is_success(&self) -> bool

Returns true if the response is successful.

Provided Methods

fn error_code(&self) -> Option<Self::ErrorCode>

Error code.

fn business_code(&self) -> Option<Self::BusinessCode>

Business code.

fn type_uri(&self) -> Option<SharedString>

A URI reference that identifies the problem type. For successful response, it should be None.

fn title(&self) -> Option<SharedString>

A short, human-readable summary of the problem type. For successful response, it should be None.

fn message(&self) -> Option<SharedString>

A context-specific descriptive message. If the response is not successful, it should be a human-readable explanation specific to this occurrence of the problem.

Object Safety

This trait is not object safe.

Implementors

impl ResponseCode for StatusCode

type ErrorCode = Cow<'static, str>

type BusinessCode = u16

const OK: Self = StatusCode::OK

const BAD_REQUEST: Self = StatusCode::BAD_REQUEST

const INTERNAL_SERVER_ERROR: Self = StatusCode::INTERNAL_SERVER_ERROR