Arc.ValidationResult (cratis_arc v0.1.0)

Copy Markdown View Source

One validation outcome, carried in the command and query result envelopes.

reason is an open set ("rule", "concurrencyViolation", "constraintViolation", "validatorFailed", "dependencyUnavailable", "malformedRequest", "frameworkFailure"); clients must tolerate values added later.

Summary

Types

severity()
t()

Functions

severity_value(atom)

The numeric wire value of a severity.

to_wire(result)

Converts a result to its wire map.

Types

severity()

@type severity() :: :unknown | :information | :warning | :error

t()

@type t() :: %Arc.ValidationResult{
  members: [atom() | String.t()],
  message: String.t(),
  reason: String.t(),
  reason_detail: String.t() | nil,
  severity: severity(),
  state: term()
}

Functions

severity_value(atom)

@spec severity_value(severity()) :: 0..3

The numeric wire value of a severity.

to_wire(result)

@spec to_wire(t()) :: map()

Converts a result to its wire map.