Struct Error 

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub remediation: String,
    pub context: ErrorContext,
}

The wire-format error envelope: { error: { code, message, remediation, context } }.

Always paired with an out-of-band request_id (returned in the X-Request-Id header or alongside the envelope at the response root). Constructed via Error::builder.

Fields

code: ErrorCode

Stable machine-readable code (see ErrorCode).

message: String

Operator-facing summary. One sentence, no trailing period.

remediation: String

Concrete next step for the caller. Always populated (Constitution V).

context: ErrorContext

Optional structured diagnostic map; arbitrary additive keys allowed.

Implementations

impl Error

pub const fn builder(code: ErrorCode) -> ErrorBuilder

Start building an Error of the given ErrorCode.

pub const fn http_status(&self) -> u16

The HTTP status implied by this error’s code.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Error

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error