Struct ApiError

pub struct ApiError { /* private fields */ }

Struct to represent error information

Implementations

impl ApiError

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

pub fn from_source( code: impl Into<u32>, source: impl Error + Send + Sync + 'static, set_source_detail: bool, message: impl Into<MaybeString>, ) -> Self

pub fn with_code(self, code: impl Into<u32>) -> Self

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

pub fn with_details(self, details: HashMap<String, String>) -> Self

pub fn with_detail( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

pub fn set_detail( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

pub fn with_source( self, source: impl Error + Send + Sync + 'static, set_source_detail: bool, ) -> Self

pub fn set_source( &mut self, source: impl Error + Send + Sync + 'static, set_source_detail: bool, ) -> &mut Self

pub const fn code(&self) -> u32

pub const fn message(&self) -> &String

pub fn details(&self) -> Option<&HashMap<String, String>>

pub fn detail(&self, key: impl AsRef<str>) -> Option<&String>

pub fn is<E: Error + 'static>(&self) -> bool

pub fn downcast_ref<E: Error + 'static>(&self) -> Option<&E>

pub const fn api_response<Data, Meta>( self, meta: Option<Meta>, ) -> ApiResponse<Data, Meta>

pub const fn api_response_without_meta<Data, Meta>( self, ) -> ApiResponse<Data, Meta>

where Self: Sized,

pub const fn api_response_with_meta<Data, Meta>( self, meta: Meta, ) -> ApiResponse<Data, Meta>

where Self: Sized,

Trait Implementations

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 Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<Data, Meta> From<ApiError> for ApiResponse<Data, Meta>

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl<Meta> From<ApiError> for ErrorResponse<Meta>

fn from(value: ApiError) -> Self

Converts to this type from the input type.

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.