Struct ErrorResponse

#[non_exhaustive]
pub struct ErrorResponse<Meta> {
    pub error: ApiError,
    pub meta: Option<Meta>,
}

Struct to represent an error response

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

error: ApiError

meta: Option<Meta>

Implementations

impl<Meta> ErrorResponse<Meta>

pub const fn new(error: ApiError, meta: Meta) -> Self

pub const fn from_error(error: ApiError) -> Self

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

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

pub fn with_meta(self, meta: Meta) -> Self

pub fn set_meta(&mut self, meta: Meta) -> &mut 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>

Trait Implementations

impl<Meta: Debug> Debug for ErrorResponse<Meta>

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

Formats the value using the given formatter.

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

where Meta: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Meta> Display for ErrorResponse<Meta>

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

Formats the value using the given formatter.

impl<Meta: Debug> Error for ErrorResponse<Meta>

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<Meta> From<ApiError> for ErrorResponse<Meta>

fn from(value: ApiError) -> Self

Converts to this type from the input type.

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

fn from(value: ErrorResponse<Meta>) -> Self

Converts to this type from the input type.

impl<Meta> Serialize for ErrorResponse<Meta>

where Meta: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.