ViolationUnion
PackageReified.Constraint
Inspects, traverses, and renders violations.
Specification
Kind
Union
Members
19
Examples
0
conjoinSignature
Violation.conjoin violations
alternativesSignature
Violation.alternatives violations
childrenSignature
Violation.children violation
flattenSignature
Violation.flatten violation
tryExpectationSignature
Violation.tryExpectation violation
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Union cases | ||
| IsAtomic | this.IsAtomic | No description available. |
| IsAll | this.IsAll | No description available. |
| IsAny | this.IsAny | No description available. |
| Atomic | Atomic AtomicViolation | One indivisible failure. |
| All | All(first, rest) | Every listed failure occurred; the value failed several conjoined rules. |
| Any | Any(first, rest) | No alternative succeeded; each listed failure is one rejected branch. |
| Operations | ||
| conjoin | Violation.conjoin violations | Groups failures as a conjunction, returning None for no failures and the single failure unchanged for one. |
| alternatives | Violation.alternatives violations | Groups failures as rejected alternatives, returning None for no failures and the single failure unchanged for one. |
| children | Violation.children violation | The immediate children of a group, or an empty list for an atomic violation. |
| flatten | Violation.flatten violation | Every leaf of a violation tree, in report order. |
| tryExpectation | Violation.tryExpectation violation | The failing constraint's identity, when the violation is a single interpreted leaf. |
| tryActual | Violation.tryActual violation | The value that failed, when the violation is a single leaf carrying a portable one. |
| tryDescription | Violation.tryDescription violation | The author-supplied prose, when the violation is a single opaque leaf. |
| tryDescriptionKey | Violation.tryDescriptionKey violation | The author-supplied catalogue key, when the violation is a single opaque leaf carrying one. |
| render | Violation.render violation | Renders a violation as an English sentence fragment with no trailing punctuation, keeping conjunction and alternative groups distinct. |
| toMessageTree | Violation.toMessageTree violation | Projects a violation for an external localization system, preserving its grouping so a translator renders conjunctions and alternatives in their own word order. |
| renderWith | Violation.renderWith lookup violation | Renders a violation through a caller-supplied lookup, keeping the same grouping and separators render uses. |
| message | Violation.message renderer violation | Renders a violation as a localized predicate, with no attribute noun. |
| fullMessage | Violation.fullMessage renderer violation | Renders a violation as a complete sentence fragment, with the attribute noun composed once. |
Union cases
kind:member
kind:member
Operations
kind:member
Groups failures as a conjunction, returning
None for no failures and the single failure unchanged
for one.
Parameters
| Name | Type | Description |
|---|---|---|
| violations | Violation list |
Returns
Violation option
Verification Examples
[ first; second ] |> Violation.conjoin // Some (All (first, [ second ]))kind:member
Groups failures as rejected alternatives, returning
None for no failures and the single failure
unchanged for one.
Parameters
| Name | Type | Description |
|---|---|---|
| violations | Violation list |
Returns
Violation option
Verification Examples
[ first; second ] |> Violation.alternatives // Some (Any (first, [ second ]))kind:member
kind:member
kind:member
kind:member
kind:member
kind:member
kind:member
Renders a violation as an English sentence fragment with no trailing punctuation, keeping conjunction and
alternative groups distinct.
Parameters
| Name | Type | Description |
|---|---|---|
| violation | Violation |
Returns
string
Verification Examples
Violation.render (Atomic (Expected (PresenceAtom Present, None)))
// "value must be present"kind:member
Projects a violation for an external localization system, preserving its grouping so a translator renders
conjunctions and alternatives in their own word order.
Parameters
| Name | Type | Description |
|---|---|---|
| violation | Violation |
Returns
MessageTree
Verification Examples
match Violation.toMessageTree violation with
| MessageTree.Leaf (MessageLeaf.Localized descriptor) -> MessageDescriptor.key descriptor
| _ -> "constraint.group"kind:member
Renders a violation through a caller-supplied lookup, keeping the same grouping and separators
render uses.
Parameters
| Name | Type | Description |
|---|---|---|
| lookup | MessageDescriptor -> string | |
| violation | Violation |
Returns
string
Verification Examples
violation |> Violation.renderWith (fun descriptor -> resources.Format(descriptor.Key, descriptor.Arguments))kind:member
Renders a violation as a localized predicate, with no attribute noun.
Parameters
| Name | Type | Description |
|---|---|---|
| renderer | Renderer | |
| violation | Violation |
Returns
string
Verification Examples
violation |> Violation.message (renderer |> Renderer.context "signup" |> Renderer.attribute "name")
// "must be at least 13, but was 11"kind:member
Renders a violation as a complete sentence fragment, with the attribute noun composed once.
Parameters
| Name | Type | Description |
|---|---|---|
| renderer | Renderer | |
| violation | Violation |
Returns
string
Verification Examples
violation |> Violation.fullMessage (signup |> Renderer.attribute "name")
// "Name must be present"