ConstraintAtomUnion

PackageReified.Constraint
Projects message keys and default English phrases from expectation values.

Specification

Kind
Union
Members
17
Examples
0
keySignature
ConstraintAtom.key atom
argumentsSignature
ConstraintAtom.arguments atom
renderSignature
ConstraintAtom.render atom
IsNumberAtomSignature
this.IsNumberAtom
IsCardinalityAtomSignature
this.IsCardinalityAtom

Summary

NameSignatureSynopsis
Union cases
IsNumberAtomthis.IsNumberAtomNo description available.
IsCardinalityAtomthis.IsCardinalityAtomNo description available.
IsRelationAtomthis.IsRelationAtomNo description available.
IsFormatAtomthis.IsFormatAtomNo description available.
IsPresenceAtomthis.IsPresenceAtomNo description available.
IsMembershipAtomthis.IsMembershipAtomNo description available.
IsUniquenessAtomthis.IsUniquenessAtomNo description available.
PresenceAtomPresenceAtom PresenceA presence rule.
CardinalityAtomCardinalityAtom CardinalityA text length or collection count rule.
RelationAtomRelationAtom RelationAn ordering or equality rule.
MembershipAtomMembershipAtom MembershipA membership rule.
UniquenessAtomUniquenessAtomA no-duplicates rule.
FormatAtomFormatAtom FormatA built-in text format rule.
NumberAtomNumberAtom NumberA numeric-property rule.
Operations
keyConstraintAtom.key atomThe stable message key for an atom, derived mechanically from its case.
argumentsConstraintAtom.arguments atomThe expectation operands an atom carries, named for message interpolation.
renderConstraintAtom.render atomThe default English phrase describing what an atom expected.

Union cases

kind:member

IsNumberAtom

this.IsNumberAtom
Member

Returns

bool
kind:member

IsCardinalityAtom

this.IsCardinalityAtom
Member

Returns

bool
kind:member

IsRelationAtom

this.IsRelationAtom
Member

Returns

bool
kind:member

IsFormatAtom

this.IsFormatAtom
Member

Returns

bool
kind:member

IsPresenceAtom

this.IsPresenceAtom
Member

Returns

bool
kind:member

IsMembershipAtom

this.IsMembershipAtom
Member

Returns

bool
kind:member

IsUniquenessAtom

this.IsUniquenessAtom
Member

Returns

bool
kind:member

PresenceAtom

PresenceAtom Presence
Member
A presence rule.

Parameters

NameTypeDescription
ItemPresence

Returns

unit
kind:member

CardinalityAtom

CardinalityAtom Cardinality
Member
A text length or collection count rule.

Parameters

NameTypeDescription
ItemCardinality

Returns

unit
kind:member

RelationAtom

RelationAtom Relation
Member
An ordering or equality rule.

Parameters

NameTypeDescription
ItemRelation

Returns

unit
kind:member

MembershipAtom

MembershipAtom Membership
Member
A membership rule.

Parameters

NameTypeDescription
ItemMembership

Returns

unit
kind:member

UniquenessAtom

UniquenessAtom
Member
A no-duplicates rule. The duplicate itself appears as the violation's actual value.

Returns

unit
kind:member

FormatAtom

FormatAtom Format
Member
A built-in text format rule.

Parameters

NameTypeDescription
ItemFormat

Returns

unit
kind:member

NumberAtom

NumberAtom Number
Member
A numeric-property rule.

Parameters

NameTypeDescription
ItemNumber

Returns

unit

Operations

kind:member

key

ConstraintAtom.key atom
Member
The stable message key for an atom, derived mechanically from its case.

Parameters

NameTypeDescription
atomConstraintAtom

Returns

string

Verification Examples

ConstraintAtom.key (RelationAtom (Compared (AtLeast, ConstraintValue.Integer 3L)))
 // "constraint.relation.atLeast"
kind:member

arguments

ConstraintAtom.arguments atom
Member
The expectation operands an atom carries, named for message interpolation.

Parameters

NameTypeDescription
atomConstraintAtom

Returns

Map<string, ConstraintValue>
kind:member

render

ConstraintAtom.render atom
Member
The default English phrase describing what an atom expected.

Parameters

NameTypeDescription
atomConstraintAtom

Returns

string