Struct Error 

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub subject: Option<Subject>,
    pub correlation_id: Option<CorrelationId>,
    pub causation_id: Option<CausationId>,
    pub details: Option<Value>,
}

The canonical error type. Transport adapters project this into GraphQL errors, MQTT error topics, SSE error frames, etc. Transport adapters must not define their own error types.

Fields

code: ErrorCode

Canonical error code.

message: String

Human-readable error message.

subject: Option<Subject>

Subject the error relates to.

correlation_id: Option<CorrelationId>

Correlation id.

causation_id: Option<CausationId>

Causation id.

details: Option<Value>

Optional structured details.

Implementations

impl Error

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

Construct an error with a code and message.

pub fn transport_error(msg: impl Into<String>) -> Self

Construct a transport error.

pub fn resolver_error(msg: impl Into<String>) -> Self

Construct a resolver error.

pub fn cache_miss(msg: impl Into<String>) -> Self

Construct a cache-miss error.

pub fn validation_error(msg: impl Into<String>) -> Self

Construct a validation error.

pub fn timeout(msg: impl Into<String>) -> Self

Construct a timeout error.

pub fn internal_error(msg: impl Into<String>) -> Self

Construct an internal error.

pub fn with_subject(self, s: Subject) -> Self

Set the subject.

pub fn with_correlation(self, id: CorrelationId) -> Self

Set the correlation id.

pub fn with_causation(self, id: CausationId) -> Self

Set the causation id.

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

Set structured details.

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 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 From<SubjectError> for Error

fn from(e: SubjectError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

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