ConstraintValueModule

PackageReified.Constraint
Builds and renders portable constraint values.

Summary

NameSignatureSynopsis
Union cases
IsTextthis.IsTextNo description available.
IsTimeSpanthis.IsTimeSpanNo description available.
IsNullthis.IsNullNo description available.
IsIntegerthis.IsIntegerNo description available.
IsBooleanthis.IsBooleanNo description available.
IsDecimalthis.IsDecimalNo description available.
IsBigIntegerthis.IsBigIntegerNo description available.
IsDateTimeOffsetthis.IsDateTimeOffsetNo description available.
IsCharthis.IsCharNo description available.
IsListthis.IsListNo description available.
IsFloat32this.IsFloat32No description available.
IsFloatthis.IsFloatNo description available.
IsGuidthis.IsGuidNo description available.
IsDateTimethis.IsDateTimeNo description available.
TextText stringText.
CharChar charA single character.
IntegerInteger int64An integral value that fits a signed 64-bit integer.
BigIntegerBigInteger bigintAn arbitrary-width integer.
DecimalDecimal decimalAn exact base-10 value.
FloatFloat PortableFloatAn IEEE double, retained without passing through decimal.
Float32Float32 PortableFloat32An IEEE single, retained without passing through decimal.
BooleanBoolean boolA Boolean.
GuidGuid GuidA globally unique identifier, kept distinct from its textual spelling.
DateTimeDateTime DateTimeA date and time without an offset.
DateTimeOffsetDateTimeOffset DateTimeOffsetA date and time with an offset from UTC.
TimeSpanTimeSpan TimeSpanA duration.
NullNullAn absent reference.
ListList ConstraintValue listAn ordered collection of portable values.
Operations
ofFloatConstraintValue.ofFloat valueWraps an IEEE double.
ofFloat32ConstraintValue.ofFloat32 valueWraps an IEEE single.
tryCreateConstraintValue.tryCreate valueProjects a runtime value to its portable representation, or None when the type is outside the closed set.
ofOperandConstraintValue.ofOperand valueProjects an operand to its portable representation, resolving ambiguous types at the call site.
renderConstraintValue.render valueRenders a portable value for a default English message.

Union cases

kind:member

IsText

this.IsText
Member

Returns

bool
kind:member

IsTimeSpan

this.IsTimeSpan
Member

Returns

bool
kind:member

IsNull

this.IsNull
Member

Returns

bool
kind:member

IsInteger

this.IsInteger
Member

Returns

bool
kind:member

IsBoolean

this.IsBoolean
Member

Returns

bool
kind:member

IsDecimal

this.IsDecimal
Member

Returns

bool
kind:member

IsBigInteger

this.IsBigInteger
Member

Returns

bool
kind:member

IsDateTimeOffset

this.IsDateTimeOffset
Member

Returns

bool
kind:member

IsChar

this.IsChar
Member

Returns

bool
kind:member

IsList

this.IsList
Member

Returns

bool
kind:member

IsFloat32

this.IsFloat32
Member

Returns

bool
kind:member

IsFloat

this.IsFloat
Member

Returns

bool
kind:member

IsGuid

this.IsGuid
Member

Returns

bool
kind:member

IsDateTime

this.IsDateTime
Member

Returns

bool
kind:member

Text

Text string
Member
Text.

Parameters

NameTypeDescription
Itemstring

Returns

unit
kind:member

Char

Char char
Member
A single character.

Parameters

NameTypeDescription
Itemchar

Returns

unit
kind:member

Integer

Integer int64
Member
An integral value that fits a signed 64-bit integer.

Parameters

NameTypeDescription
Itemint64

Returns

unit
kind:member

BigInteger

BigInteger bigint
Member
An arbitrary-width integer.

Parameters

NameTypeDescription
Itembigint

Returns

unit
kind:member

Decimal

Decimal decimal
Member
An exact base-10 value.

Parameters

NameTypeDescription
Itemdecimal

Returns

unit
kind:member

Float

Float PortableFloat
Member
An IEEE double, retained without passing through decimal.

Parameters

NameTypeDescription
ItemPortableFloat

Returns

unit
kind:member

Float32

Float32 PortableFloat32
Member
An IEEE single, retained without passing through decimal.

Parameters

NameTypeDescription
ItemPortableFloat32

Returns

unit
kind:member

Boolean

Boolean bool
Member
A Boolean.

Parameters

NameTypeDescription
Itembool

Returns

unit
kind:member

Guid

Guid Guid
Member
A globally unique identifier, kept distinct from its textual spelling.

Parameters

NameTypeDescription
ItemGuid

Returns

unit
kind:member

DateTime

DateTime DateTime
Member
A date and time without an offset.

Parameters

NameTypeDescription
ItemDateTime

Returns

unit
kind:member

DateTimeOffset

DateTimeOffset DateTimeOffset
Member
A date and time with an offset from UTC.

Parameters

NameTypeDescription
ItemDateTimeOffset

Returns

unit
kind:member

TimeSpan

TimeSpan TimeSpan
Member
A duration.

Parameters

NameTypeDescription
ItemTimeSpan

Returns

unit
kind:member

Null

Null
Member
An absent reference. Distinct from "no portable representation available".

Returns

unit
kind:member

List

List ConstraintValue list
Member
An ordered collection of portable values.

Parameters

NameTypeDescription
ItemConstraintValue list

Returns

unit

Operations

kind:member

ofFloat

ConstraintValue.ofFloat value
Member
Wraps an IEEE double.

Parameters

NameTypeDescription
valuefloat

Returns

ConstraintValue
kind:member

ofFloat32

ConstraintValue.ofFloat32 value
Member
Wraps an IEEE single.

Parameters

NameTypeDescription
valuefloat32

Returns

ConstraintValue
kind:member

tryCreate

ConstraintValue.tryCreate value
Member
Projects a runtime value to its portable representation, or None when the type is outside the closed set. This never throws, including for NaN, infinities, and values no numeric case can hold.

Parameters

NameTypeDescription
value'value

Returns

ConstraintValue option

Verification Examples

ConstraintValue.tryCreate 3 = Some (ConstraintValue.Integer 3L)
kind:member

ofOperand

ConstraintValue.ofOperand value
Member
Projects an operand to its portable representation, resolving ambiguous types at the call site.

Parameters

NameTypeDescription
value'value

Returns

ConstraintValue option

Verification Examples

let instant = System.DateTimeOffset.UtcNow in ConstraintValue.ofOperand instant // Some (ConstraintValue.DateTimeOffset instant)
kind:member

render

ConstraintValue.render value
Member
Renders a portable value for a default English message. Not a wire format.

Parameters

NameTypeDescription
valueConstraintValue

Returns

string