RendererModule
PackageReified.Constraint
Builds renderers and renders messages through them.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| english | Renderer.english | A renderer that uses each catalogue's neutral English, with no resources at all. |
| ofLookup | Renderer.ofLookup lookup | A renderer backed by any key-to-template lookup. |
| ofResourceManager | Renderer.ofResourceManager resources culture | A renderer backed by a .NET resource manager, using one culture for everything. |
| ofResourceManagerWithCultures | Renderer.ofResourceManagerWithCultures resources uiCulture valueCulture | A renderer that looks messages up in one culture and formats operands in another. |
| ofCurrentCulture | Renderer.ofCurrentCulture resources | A renderer that reads the ambient cultures at each render rather than capturing them. |
| context | Renderer.context segment renderer | Appends a document, model, form, or component segment. |
| attribute | Renderer.attribute segment renderer | Replaces the attribute with one segment. |
| unscoped | Renderer.unscoped renderer | Clears both the context and the attribute. |
| withValues | Renderer.withValues format renderer | Replaces all operand rendering with one callback, ignoring placeholder format suffixes. |
| attributeName | Renderer.attributeName renderer | The attribute noun this renderer composes into a full message. |
| fullMessage | Renderer.fullMessage message renderer | Composes the attribute noun once around an already-rendered message. |
A renderer that uses each catalogue's neutral English, with no resources at all.
Returns
Renderer
Verification Examples
violation |> Violation.fullMessage Renderer.english // "value must be present"A renderer backed by any key-to-template lookup.
Parameters
| Name | Type | Description |
|---|---|---|
| lookup | MessageLookup |
Returns
Renderer
Verification Examples
let translations : Map<string, string> = Map.empty
let renderer = Renderer.ofLookup translations.TryFindA renderer backed by a .NET resource manager, using one culture for everything.
Parameters
| Name | Type | Description |
|---|---|---|
| resources | ResourceManager | |
| culture | CultureInfo |
Returns
Renderer
Verification Examples
let resources : Resources.ResourceManager = Unchecked.defaultof<_> in let renderer = Renderer.ofResourceManager resources (Globalization.CultureInfo "fr-FR")Renderer.ofResourceManagerWithCultures resources uiCulture valueCulture
MemberA renderer that looks messages up in one culture and formats operands in another.
Parameters
| Name | Type | Description |
|---|---|---|
| resources | ResourceManager | |
| uiCulture | CultureInfo | |
| valueCulture | CultureInfo |
Returns
Renderer
Verification Examples
let resources : Resources.ResourceManager = Unchecked.defaultof<_> in Renderer.ofResourceManagerWithCultures resources (Globalization.CultureInfo "en") (Globalization.CultureInfo "de-DE")A renderer that reads the ambient cultures at each render rather than capturing them.
Parameters
| Name | Type | Description |
|---|---|---|
| resources | ResourceManager |
Returns
Renderer
Verification Examples
let resources : Resources.ResourceManager = Unchecked.defaultof<_> in let renderer = Renderer.ofCurrentCulture resourcesAppends a document, model, form, or component segment.
Parameters
| Name | Type | Description |
|---|---|---|
| segment | string | |
| renderer | Renderer |
Returns
Renderer
Verification Examples
let signup = renderer |> Renderer.context "signup"Replaces the attribute with one segment.
Parameters
| Name | Type | Description |
|---|---|---|
| segment | string | |
| renderer | Renderer |
Returns
Renderer
Verification Examples
signup |> Renderer.attribute "name"Clears both the context and the attribute.
Parameters
| Name | Type | Description |
|---|---|---|
| renderer | Renderer |
Returns
Renderer
Verification Examples
let bare = signup |> Renderer.unscopedReplaces all operand rendering with one callback, ignoring placeholder format suffixes.
Parameters
| Name | Type | Description |
|---|---|---|
| format | ConstraintValue -> string | |
| renderer | Renderer |
Returns
Renderer
Verification Examples
renderer |> Renderer.withValues (fun value -> ConstraintValue.render value)The attribute noun this renderer composes into a full message.
Parameters
| Name | Type | Description |
|---|---|---|
| renderer | Renderer |
Returns
string
Verification Examples
signup |> Renderer.attribute "postcodeID" |> Renderer.attributeName // "Postcode ID"