MessageDescriptorModule

PackageReified.Constraint
Reads and builds message identities.

Summary

NameSignatureSynopsis
keyMessageDescriptor.key descriptorThe canonical unencoded key, exactly as authored.
argumentsMessageDescriptor.arguments descriptorThe operands the message interpolates, named for the template.
segmentsMessageDescriptor.segments descriptorThe parsed, unencoded key segments.

key

MessageDescriptor.key descriptor
Member
The canonical unencoded key, exactly as authored.

Parameters

NameTypeDescription
descriptorMessageDescriptor

Returns

string

Verification Examples

let descriptor = MessageDescriptor.Advanced.create "books.isbn.invalid" Map.empty in MessageDescriptor.key descriptor // "books.isbn.invalid"

arguments

MessageDescriptor.arguments descriptor
Member
The operands the message interpolates, named for the template.

Parameters

NameTypeDescription
descriptorMessageDescriptor

Returns

Map<string, ConstraintValue>

Verification Examples

let descriptor = MessageDescriptor.Advanced.create "books.isbn.invalid" Map.empty in MessageDescriptor.arguments descriptor |> Map.tryFind "expectedLength"

segments

MessageDescriptor.segments descriptor
Member
The parsed, unencoded key segments.

Parameters

NameTypeDescription
descriptorMessageDescriptor

Returns

string list