Struct ApiError 

pub struct ApiError {
    pub code: String,
    pub message: String,
    pub details: Option<Value>,
}

Generic error response for the API.

Fields

code: String

message: String

details: Option<Value>

Implementations

impl ApiError

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

pub fn unauthorized(msg: &str) -> Self

pub fn forbidden(msg: &str) -> Self

pub fn not_found(msg: &str) -> Self

pub fn bad_request(msg: &str) -> Self

pub fn conflict(msg: &str) -> Self

pub fn internal_error(msg: &str) -> Self

pub fn internal(msg: &str) -> Self

pub fn validation(msg: &str) -> Self

pub fn already_exists(msg: &str) -> Self

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ApiError

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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.