SchemaErrorUnion

PackageReified.Schema
Schema input, checking, and contextual rule failures attached to diagnostics paths.

Specification

Kind
Union
Members
22
Examples
0
IsCustomSignature
this.IsCustom
IsExpectedObjectSignature
this.IsExpectedObject
IsConstructorFailedSignature
this.IsConstructorFailed
IsExpectedScalarSignature
this.IsExpectedScalar
IsParseOutOfRangeSignature
this.IsParseOutOfRange

Summary

NameSignatureSynopsis
IsCustomthis.IsCustomNo description available.
IsExpectedObjectthis.IsExpectedObjectNo description available.
IsConstructorFailedthis.IsConstructorFailedNo description available.
IsExpectedScalarthis.IsExpectedScalarNo description available.
IsParseOutOfRangethis.IsParseOutOfRangeNo description available.
IsViolationthis.IsViolationNo description available.
IsOmittedthis.IsOmittedNo description available.
IsInvalidFormatthis.IsInvalidFormatNo description available.
IsExpectedManythis.IsExpectedManyNo description available.
IsBlankthis.IsBlankNo description available.
IsUnknownTagthis.IsUnknownTagNo description available.
OmittedOmittedRequired boundary input was not supplied.
BlankBlankBoundary input was present but carried no value.
ExpectedScalarExpectedScalarA scalar was expected at this path.
ExpectedObjectExpectedObjectAn object was expected at this path.
ExpectedManyExpectedManyA collection was expected at this path.
InvalidFormatInvalidFormat expectedThe input could not be read as the named target type.
ParseOutOfRangeParseOutOfRange targetThe input was well-formed but outside the target type's representable range.
UnknownTagUnknownTag choicesA union or enum discriminator did not name one of the declared cases.
ViolationViolation violationThe value was read successfully and then failed its constraint.
ConstructorFailedConstructorFailed messageThe model constructor rejected an otherwise admissible set of field values.
CustomCustom(code, message)A Schema-owned intrinsic check failed.

IsCustom

this.IsCustom
Member

Returns

bool

IsExpectedObject

this.IsExpectedObject
Member

Returns

bool

IsConstructorFailed

this.IsConstructorFailed
Member

Returns

bool

IsExpectedScalar

this.IsExpectedScalar
Member

Returns

bool

IsParseOutOfRange

this.IsParseOutOfRange
Member

Returns

bool

IsViolation

this.IsViolation
Member

Returns

bool

IsOmitted

this.IsOmitted
Member

Returns

bool

IsInvalidFormat

this.IsInvalidFormat
Member

Returns

bool

IsExpectedMany

this.IsExpectedMany
Member

Returns

bool

IsBlank

this.IsBlank
Member

Returns

bool

IsUnknownTag

this.IsUnknownTag
Member

Returns

bool

Omitted

Omitted
Member
Required boundary input was not supplied.

Returns

unit

Blank

Blank
Member
Boundary input was present but carried no value. The parse-side lowering of a missing value.

Returns

unit

ExpectedScalar

ExpectedScalar
Member
A scalar was expected at this path.

Returns

unit

ExpectedObject

ExpectedObject
Member
An object was expected at this path.

Returns

unit

ExpectedMany

ExpectedMany
Member
A collection was expected at this path.

Returns

unit

InvalidFormat

InvalidFormat expected
Member
The input could not be read as the named target type.

Parameters

NameTypeDescription
expectedstring

Returns

unit

ParseOutOfRange

ParseOutOfRange target
Member
The input was well-formed but outside the target type's representable range.

Parameters

NameTypeDescription
targetstring

Returns

unit

UnknownTag

UnknownTag choices
Member
A union or enum discriminator did not name one of the declared cases.

Parameters

NameTypeDescription
choicesstring

Returns

unit

Violation

Violation violation
Member
The value was read successfully and then failed its constraint.

Parameters

NameTypeDescription
violationViolation

Returns

unit

ConstructorFailed

ConstructorFailed message
Member
The model constructor rejected an otherwise admissible set of field values.

Parameters

NameTypeDescription
messagestring

Returns

unit

Custom

Custom(code, message)
Member
A Schema-owned intrinsic check failed.

Parameters

NameTypeDescription
codestring
messagestring option

Returns

unit