Struct ErrorEnvelope 

#[non_exhaustive]
pub struct ErrorEnvelope {
    pub message: Option<String>,
    pub code: Option<String>,
    pub error_type: Option<String>,
    pub param: Option<String>,
}

The fields of a recognised JSON error envelope (see error_envelope).

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.

message: Option<String>

The provider’s error text. Upstream text: it belongs in Error::with_upstream_message, never in an authored message.

code: Option<String>

Provider error code. Numeric codes are kept as their decimal text.

error_type: Option<String>

Provider error type or category.

param: Option<String>

The path of the rejected request field, such as messages.[1].content.

Implementations

impl ErrorEnvelope

pub fn apply(self, error: Error) -> Error

Attach the envelope to error: the message as its upstream message, the code, type and rejected field as its provider code, provider type and param.

Trait Implementations

impl Clone for ErrorEnvelope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorEnvelope

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

Formats the value using the given formatter.

impl Default for ErrorEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ErrorEnvelope

impl PartialEq for ErrorEnvelope

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ErrorEnvelope