Struct ErrorPayload 

pub struct ErrorPayload {
    pub code: TrustTaskCode,
    pub in_response_to: Option<InResponseTo>,
    pub message: Option<String>,
    pub retryable: bool,
    pub retry_after: Option<DateTime<Utc>>,
    pub details: Option<Value>,
}

The payload of a trust-task-error/0.5 document, per SPEC.md §8.2.

Exchange-level correlation is carried by the surrounding TrustTask’s threadId; which document this error reports on is carried here, by in_response_to.

Fields

code: TrustTaskCode

Short identifier for the failure category.

in_response_to: Option<InResponseTo>

Identifies the Trust Task document this error reports on (SPEC.md §8.2).

threadId correlates the exchange for a party that saw the originating request, and identifies nothing to anyone else. Without this, a retained error names neither the specification the failure occurred under nor the instance that triggered it — and for the standard codes of §8.3 there is no other signal of origin at all.

SHOULD be populated in general, and MUST be where the error will be retained, replayed, or relied upon beyond the original producer. The document builders on TrustTask populate it for you.

message: Option<String>

Human-readable description. Non-normative; intended for logs and operator UI.

retryable: bool

Whether the producer MAY retry the original document. Per SPEC.md §8.4, “retry” means re-sending bit-for-bit; a new document with a fresh id is not a retry.

retry_after: Option<DateTime<Utc>>

Earliest time at which the producer SHOULD retry. Meaningful only when retryable is true.

details: Option<Value>

Task-specific extension data. The shape is defined by the originating Trust Task specification (SPEC.md §8.5).

Implementations

impl ErrorPayload

pub fn new(code: impl Into<TrustTaskCode>) -> ErrorPayload

Construct a minimal payload for code. retryable is initialized to the code’s default per the §8.3 table (overridable via with_retryable). All other members are absent.

pub fn about( self, type_uri: impl Into<String>, id: Option<String>, ) -> ErrorPayload

Name the document this error reports on (SPEC.md §8.2).

Prefer the builders on TrustTask, which populate this from the request being rejected — including the §8.1 rule that the id is omitted under identityMismatch. Use this directly only when constructing a payload without the originating document in hand.

pub fn with_message(self, message: impl Into<String>) -> ErrorPayload

Attach a human-readable message.

pub fn with_retryable(self, retryable: bool) -> ErrorPayload

Override the retryable flag (default is taken from StandardCode::default_retryable).

pub fn with_retry_after(self, when: DateTime<Utc>) -> ErrorPayload

Attach a retryAfter hint. Meaningful only when retryable is true.

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

Attach task-specific extension data.

pub fn effective_code(&self) -> StandardCode

Resolve this payload’s code to a StandardCode the consumer is guaranteed to recognize, applying the SPEC §8.5 fallback: unrecognized extension codes collapse to StandardCode::TaskFailed.

Standard codes are returned as-is.

pub fn should_retry_at(&self, now: DateTime<Utc>) -> bool

Apply the SPEC §8.4 retry-semantics check.

Returns true only when:

• retryable is true, AND
• retry_after is either absent or already past now.

A false return means the producer MUST NOT retry yet (or at all, when retryable is false). “Retry” here is the strict bit-for-bit sense from SPEC §8.4 — issuing a new document with a fresh id is always permitted regardless of this value.

Trait Implementations

impl Clone for ErrorPayload

fn clone(&self) -> ErrorPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorPayload

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

Formats the value using the given formatter.

impl Eq for ErrorPayload

impl Error for ErrorPayload

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<RejectReason> for ErrorPayload

fn from(reason: RejectReason) -> ErrorPayload

Converts to this type from the input type.

impl From<StandardCode> for ErrorPayload

fn from(code: StandardCode) -> ErrorPayload

Converts to this type from the input type.

impl From<TrustTaskCode> for ErrorPayload

fn from(code: TrustTaskCode) -> ErrorPayload

Converts to this type from the input type.

impl PartialEq for ErrorPayload

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ErrorPayload

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.

impl StructuralPartialEq for ErrorPayload