Skip to main content

ErrorResponse

Type Alias ErrorResponse 

Source
pub type ErrorResponse = TrustTask<ErrorPayload>;
Expand description

A trust-task-error document — a TrustTask whose payload is an ErrorPayload. This type alias is the form most consumer code holds onto when raising or propagating an error response.

Aliased Type§

pub struct ErrorResponse {
Show 13 fields pub id: String, pub thread_id: Option<String>, pub parent_thread_id: Option<String>, pub ceremony: Option<Ceremony>, pub type_uri: TypeUri, pub issuer: Option<String>, pub recipient: Option<String>, pub issued_at: Option<DateTime<Utc>>, pub expires_at: Option<DateTime<Utc>>, pub payload: ErrorPayload, pub context: Option<JsonLdContext>, pub proof: Option<Proof>, pub extra: BTreeMap<String, Value>,
}

Fields§

§id: String

The document identifier — globally unique to this instance.

§thread_id: Option<String>

The thread identifier correlating this document with others in the same logical exchange (SPEC.md §4.9).

§parent_thread_id: Option<String>

The threadId of the exchange containing this one, where this exchange is conducted inside another (SPEC.md §4.9.2).

A navigation aid. It records one level of containment and does not change which exchange attests an event — §4.9.1 governs that, and holds whether or not this member is present. Like thread_id it carries no normative validation semantics: a consumer MUST NOT reject a document on the basis of parentThreadId alone.

§ceremony: Option<Ceremony>

Records that this document is a step of a Trust Ceremony — a flow composed of several Trust Tasks (SPEC.md §4.11).

Optional in every sense: no specification declares anything about ceremonies, a document without it is fully conforming, and a consumer that does not implement ceremonies processes the document unchanged. Ignoring it is always safe, because §4.11.4 forbids deriving authority from it — there is nothing a ceremony-aware consumer may do that an unaware one omits.

§type_uri: TypeUri

The Type URI identifying the specification and version this document conforms to.

§issuer: Option<String>

VID of the party responsible for the document’s content.

§recipient: Option<String>

VID of the party expected to act upon the document.

§issued_at: Option<DateTime<Utc>>

Timestamp recording when the document was produced (SPEC.md §4.2).

§expires_at: Option<DateTime<Utc>>

Timestamp after which the document is no longer valid (SPEC.md §4.2).

§payload: ErrorPayload

The task-specific body, whose internal structure is defined by the specification identified by type_uri.

§context: Option<JsonLdContext>

Optional JSON-LD context (SPEC.md §4.6). When present, the document MUST be processable as JSON-LD.

§proof: Option<Proof>

Optional Data Integrity proof binding the document to its issuer.

§extra: BTreeMap<String, Value>

Any additional top-level members carried by the document. Preserved on round-trip per the §7.1 / §7.2 guidance to retain unrecognized members.