Struct EnvelopeError 

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

Structured error rendered inside the JSON envelope’s error field.

Fields

code: String

message: String

hint: Option<String>

details: Option<Value>

Implementations

impl EnvelopeError

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

Build an error with a code and message.

pub fn with_hint(self, hint: impl Into<String>) -> EnvelopeError

Attach an optional human-readable hint to the error.

pub fn with_details(self, details: Value) -> EnvelopeError

Attach optional machine-readable structured detail to the error (e.g. the offending payload path).

Trait Implementations

impl Clone for EnvelopeError

fn clone(&self) -> EnvelopeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeError

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

Formats the value using the given formatter.

impl Serialize for EnvelopeError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.