Struct ErrorEnvelope 

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

Error response body.

The inner part of the API error envelope: { "error": { "code": "...", "message": "...", "details": { ... } } }.

details carries error-specific structured context (for example the run holding a conflicting idempotency key). It is omitted from the JSON output when absent.

Examples

use ironflow_types::ErrorEnvelope;

let json = r#"{"code": "RUN_NOT_FOUND", "message": "run not found"}"#;
let err: ErrorEnvelope = serde_json::from_str(json).unwrap();
assert_eq!(err.code, "RUN_NOT_FOUND");
assert!(err.details.is_none());

Fields

code: String

Machine-readable error code (e.g., RUN_NOT_FOUND).

message: String

Human-readable error message.

details: Option<Value>

Optional structured context attached to the error.

Trait Implementations

impl Clone for ErrorEnvelope

fn clone(&self) -> ErrorEnvelope

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorEnvelope

fn deserialize<__D>( __deserializer: __D, ) -> Result<ErrorEnvelope, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ErrorEnvelope

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.