Struct DeclaredErrorCode 

#[non_exhaustive]
pub struct DeclaredErrorCode {
    pub code: &'static str,
    pub retryable: bool,
}

An extended error code a Trust Task specification declares in its errorCodes front matter (SPEC.md §7.3 item 9, §8.5).

trust-tasks-codegen emits one of these per declaration, as a constant in the generated module’s error_codes submodule, and collects them into that module’s ERROR_CODES slice. crate::schema_index::error_codes_for serves the same slice by Type URI, for a consumer that dispatches on the URI and has no module to name.

The point is that the code string is read from the specification, not written at the call site. A hand-written literal can name a code the specification never declared, and nothing notices: the consumer on the other end degrades it to taskFailed (§8.5) and the distinction the specification drew is lost without a trace.

use trust_tasks_rs::specs::acl::grant::v0_1 as grant;

// Emit it — `retryable` comes from the declaration, not a guess.
let payload: ErrorPayload = grant::error_codes::ROLE_NOT_RECOGNIZED.into();

// Or keep the wire string, in a `const` context.
const ROLE_NOT_RECOGNIZED: &str = grant::error_codes::ROLE_NOT_RECOGNIZED.code;

#[non_exhaustive] so the declaration’s other members (meaning, detailsSchema) can be carried later without a breaking change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: &'static str

The fully qualified code as it appears on the wire, <namespace>:<local> — e.g. "acl/grant:roleNotRecognized". The namespace is the declaring specification’s slug or a family prefix of it (§8.5 rule 2).

retryable: bool

The retryable value the specification declares for this code — the value an emitter SHOULD send (§8.4).

Implementations

impl DeclaredErrorCode

pub fn namespace(&self) -> &'static str

The namespace before the colon: the declaring specification’s slug, or a family prefix of it.

pub fn local(&self) -> &'static str

The local part after the colon, e.g. "roleNotRecognized".

pub fn matches(&self, code: &TrustTaskCode) -> bool

Whether code is this declared code.

A method rather than PartialEq<DeclaredErrorCode> for TrustTaskCode: a second PartialEq impl on TrustTaskCode makes every assert_eq!(code, StandardCode::X.into()) ambiguous, which would break consumers that compile today.

Compares namespace and local part, so a TrustTaskCode parsed off the wire and one built with Payload::extended_code both match.

Trait Implementations

impl Clone for DeclaredErrorCode

fn clone(&self) -> DeclaredErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DeclaredErrorCode

impl Debug for DeclaredErrorCode

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

Formats the value using the given formatter.

impl Display for DeclaredErrorCode

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

Formats the value using the given formatter.

impl Eq for DeclaredErrorCode

impl From<DeclaredErrorCode> for TrustTaskCode

fn from(declared: DeclaredErrorCode) -> TrustTaskCode

Infallible: the generator refuses to emit a code that does not parse, so a DeclaredErrorCode from crate::specs always converts.

impl From<DeclaredErrorCode> for ErrorPayload

fn from(declared: DeclaredErrorCode) -> ErrorPayload

An error payload carrying declared, with retryable set to the value the specification declares rather than the §8.5 taskFailed default ErrorPayload::new applies to an extended code it knows nothing about.

impl Hash for DeclaredErrorCode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DeclaredErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeclaredErrorCode