Struct kapitalist_types::response::ErrorResponse

pub struct ErrorResponse {
    pub error: String,
}

Generic error response with an error message indicating what went wrong

Clients should use the error message in combination with the HTTP return type to determine how to handle the error.

Fields

error: String

Message describing the error

Methods

impl ErrorResponse

pub fn new<S>(err: S) -> Self where
    S: Into<String>, 

Construct a new ErrorResponse from a given error message

pub fn internal_server_error() -> Self

Utility function to return a generic "Internal server error"

This is usually used in production to hide potentially sensitive error details.

pub fn not_implemented() -> Self

Utility function to return a generic "Not implemented yet" error

pub fn unauthorized() -> Self

Utility function to return a generic "Unauthorized" error

Trait Implementations

impl Debug for ErrorResponse

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

Formats the value using the given formatter.

impl Serialize for ErrorResponse

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ErrorResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.