Ballerina library

constraint

Module constraint

API

validate

Declarations

DateOption

Array
Date
Float
Int
Number
String

Definitions

ArrayConstraints
ConstraintRecord
DateConstraints
FloatConstraints
IntConstraints
NumberConstraints
StringConstraints

Error
TypeConversionError
ValidationError

ballerina/constraint Ballerina library

1.5.0

Overview

This module provides features to validate the values that have been assigned to Ballerina types.

The Ballerina constraint module facilitates APIs to do validations on the Ballerina types further with the use of annotations.

Functions

validate

Isolated Function
function validate(anydata value, typedesc<anydata> td) returns td|Error

Validates the provided value against the configured annotations. Additionally, if the type of the value is different from the expected return type then the value will be cloned with the contextually expected type before the validation.

Parameters
  • value anydata - The anydata type value to be constrained
  • td typedesc<anydata> (default <>) - The type descriptor of the value to be constrained
Return Type
  • td|Error - The type descriptor of the value which is validated or else an constraint:Error in case of an error

Enums

constraint: DateOption

Represents the date option to be validated.

Members

PAST - validates whether the date is in the past
PAST_OR_PRESENT - validates whether the date is in the past or present
FUTURE - validates whether the date is in the future
FUTURE_OR_PRESENT - validates whether the date is in the future or present

Annotations

constraint: Array

ArrayConstraints type, record field

The annotation, which is used for the constraints of the anydata[] type.

constraint: Date

DateConstraints type, record field

The annotation, which is used for the constraints of the Date type, which is structurally equivalent to the following record:

Copy
type Date record {
   int year;
   int month;
   int day;
};

This annotation will enable validation on the date fields in the record. Additionally, the option field can be used to validate the date against the provided option.

constraint: Float

FloatConstraints type, record field

The annotation, which is used for the constraints of the float type.

constraint: Int

IntConstraints type, record field

The annotation, which is used for the constraints of the int type.

constraint: Number

NumberConstraints type, record field

The annotation, which is used for the constraints of the int, float, and decimal types.

constraint: String

StringConstraints type, record field

The annotation, which is used for the constraints of the string type.

Records

constraint: ArrayConstraints

Closed record

Represents the constraints associated with anydata[] type.

Fields
  • length int|record {| value int |}? - The number of members of the constrained type
  • minLength int|record {| value int |}? - The inclusive lower bound of the number of members of the constrained type
  • maxLength int|record {| value int |}? - The inclusive upper bound of the number of members of the constrained type

constraint: ConstraintRecord

Closed record

Represents the constraint details as a record.

Fields
  • value anydata - The value for the constraint
  • message string - The message to be returned in case of the constraint violation

constraint: DateConstraints

Represents the constraints associated with Date type.

Fields
  • message string? - The message to be returned in case of the constraint violation

constraint: FloatConstraints

Closed record

Represents the constraints associated with float type.

Fields
  • minValue float|record {| value float |}? - The inclusive lower bound of the constrained type
  • maxValue float|record {| value float |}? - The inclusive upper bound of the constrained type
  • minValueExclusive float|record {| value float |}? - The exclusive lower bound of the constrained type
  • maxValueExclusive float|record {| value float |}? - The exclusive upper bound of the constrained type
  • maxIntegerDigits int|record {| value int |}? - The maximum number of digits in the integer part of the constrained type
  • maxFractionDigits int|record {| value int |}? - The maximum number of digits in the fraction part of the constrained type

constraint: IntConstraints

Closed record

Represents the constraints associated with int type.

Fields
  • minValue int|record {| value int |}? - The inclusive lower bound of the constrained type
  • maxValue int|record {| value int |}? - The inclusive upper bound of the constrained type
  • minValueExclusive int|record {| value int |}? - The exclusive lower bound of the constrained type
  • maxValueExclusive int|record {| value int |}? - The exclusive upper bound of the constrained type
  • maxDigits int|record {| value int |}? - The maximum number of digits in the constrained type

constraint: NumberConstraints

Closed record

Represents the constraints associated with int, float and decimal types.

Fields
  • minValue decimal|record {| value decimal |}? - The inclusive lower bound of the constrained type
  • maxValue decimal|record {| value decimal |}? - The inclusive upper bound of the constrained type
  • minValueExclusive decimal|record {| value decimal |}? - The exclusive lower bound of the constrained type
  • maxValueExclusive decimal|record {| value decimal |}? - The exclusive upper bound of the constrained type
  • maxIntegerDigits int|record {| value int |}? - The maximum number of digits in the integer part of the constrained type
  • maxFractionDigits int|record {| value int |}? - The maximum number of digits in the fraction part of the constrained type

constraint: StringConstraints

Closed record

Represents the constraints associated with string type.

Fields
  • length int|record {| value int |}? - The number of characters of the constrained string type
  • minLength int|record {| value int |}? - The inclusive lower bound of the number of characters of the constrained string type
  • maxLength int|record {| value int |}? - The inclusive upper bound of the number of characters of the constrained string type
  • pattern RegExp|record {| value RegExp |}? - The regular expression to be matched with the constrained string type

Errors

constraint: Error

Distinct

Represents the generic error type of the module.

constraint: TypeConversionError

Distinct
Error

Represents the errors occurs during the type conversion.

constraint: ValidationError

Distinct
Error

Represents the errors occurs during constraint validations.

Import

import ballerina/constraint;Copy

Metadata

Released date: about 1 month ago

Version: 1.5.0

License: Apache-2.0

Compatibility

Platform: java17

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Stats

Pull count: 5649

Source repository

Keywords

constraint
validation

Contributors

Other versions

1.5.0

1.4.01.3.01.2.01.1.0
See more...

Terms of service

Privacy policy

Cookie policy

© 2023 WSO2 LLC