Struct Problem 

pub struct Problem {
    pub problem_type: String,
    pub title: String,
    pub status: Option<u16>,
    pub detail: String,
    pub instance: Option<String>,
    pub trace_id: Option<String>,
    pub context: Value,
    pub error_code: Option<String>,
    pub error_domain: Option<String>,
}

RFC 9457 §3.1 makes every member but this struct’s Rust type reflects optional on the wire; status is Option<u16> rather than a defaulted u16 since a synthetic 0 would be an actively wrong status, not an honest “wasn’t there” (same reasoning as default_context, below). Callers that have a real status to fall back to normalize None after parsing (enrich_problem_response, map_http_error); SSE has none and preserves the absence. Serialize is unaffected - from_error always populates every field, so wire output is unchanged.

Fields

problem_type: String

title: String

status: Option<u16>

detail: String

instance: Option<String>

trace_id: Option<String>

context: Value

error_code: Option<String>

Machine-readable identifier of the typed error variant inside its domain. Set by [#[derive(ContractError)]] when a contract error crosses the wire so PRD-conformant peers can reconstruct the original Rust enum variant via error_code + error_domain. None for canonical-category-only errors.

error_domain: Option<String>

Namespace owning the error_code. Conventionally <service>.<version> (e.g. billing.v1). None when no contract error is in play.

Implementations

impl Problem

pub fn from_error(err: &CanonicalError) -> Result<Problem, Error>

Convert a CanonicalError to a Problem.

Errors

Returns serde_json::Error if the error-category context type fails to serialize. Built-in context types are plain structs and should never fail, but this keeps the failure visible rather than silently producing an empty "context": {}.

pub fn with_error_code(self, code: impl Into<String>) -> Problem

Attach the error_code extension field (PRD #1536 contract-error envelope). Returns self for chaining.

pub fn with_error_domain(self, domain: impl Into<String>) -> Problem

Attach the error_domain extension field. Returns self for chaining.

pub fn contract_error( category: ProblemCategory, error_code: impl Into<String>, error_domain: impl Into<String>, detail: impl Into<String>, data: Value, ) -> Problem

Build a Problem for a typed contract error (PRD #1536 envelope).

category selects one of the 16 canonical AIP-193 categories; the resulting Problem carries the matching GTS URI in type, the canonical HTTP status, and the canonical title. error_code and error_domain populate the PRD extension fields, and data is placed at context["data"] to carry variant-specific payload.

Used by #[derive(ContractError)] emit-paths; SDK authors rarely call this directly.

pub fn with_trace_id(self, trace_id: impl Into<String>) -> Problem

Set the trace_id field, returning self for chaining.

pub fn with_instance(self, instance: impl Into<String>) -> Problem

Set the instance field, returning self for chaining.

Trait Implementations

impl Clone for Problem

fn clone(&self) -> Problem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Problem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Problem

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CanonicalError> for Problem

fn from(err: CanonicalError) -> Problem

Converts to this type from the input type.

impl IntoResponse for Problem

Available on crate feature axum only.

fn into_response(self) -> Response<Body>

Create a response.

impl PartialSchema for Problem

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for Problem

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 ToSchema for Problem

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl TryFrom<Problem> for CanonicalError

type Error = ProblemConversionError

The type returned in the event of a conversion error.

fn try_from( problem: Problem, ) -> Result<CanonicalError, <CanonicalError as TryFrom<Problem>>::Error>

Performs the conversion.