Standard Library Assertions Functions

function

assert_eq

assert_eq asserts that two values are equal.

Inputs

Name
left
Required
required
Type
null | integer | float | integer | string | bool | addon() | array[null] | object
Description
A value to compare.
Name
right
Required
required
Type
null | integer | float | integer | string | bool | addon() | array[null] | object
Description
The value to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_eq

output "assertion" { 
    value = std::assert_eq(action.example.result, 1)
}

function

assert_ne

assert_ne asserts that two values are not equal.

Inputs

Name
left
Required
required
Type
null | integer | float | integer | string | bool | addon() | array[null] | object
Description
A value to compare.
Name
right
Required
required
Type
null | integer | float | integer | string | bool | addon() | array[null] | object
Description
The value to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_ne

output "assertion" { 
    value = std::assert_ne(action.example.result, 1)
}

function

assert_gt

assert_gt asserts that the left value is greater than the right value.

Inputs

Name
left
Required
required
Type
integer | float
Description
An integer or float to compare.
Name
right
Required
required
Type
integer | float
Description
An integer or float to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_gt

output "assertion" { 
    value = std::assert_gt(action.example.result, 1)
}

function

assert_gte

assert_gte asserts that the left value is greater than or equal to the right value.

Inputs

Name
left
Required
required
Type
integer | float
Description
An integer or float to compare.
Name
right
Required
required
Type
integer | float
Description
An integer or float to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_gte

output "assertion" { 
    value = std::assert_gte(action.example.result, 1)
}

function

assert_lt

assert_lt asserts that the left value is less than the right value.

Inputs

Name
left
Required
required
Type
integer | float
Description
An integer or float to compare.
Name
right
Required
required
Type
integer | float
Description
An integer or float to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_lt

output "assertion" { 
    value = std::assert_lt(action.example.result, 1)
}

function

assert_lte

assert_lte asserts that the left value is less than or equal to the right value.

Inputs

Name
left
Required
required
Type
integer | float
Description
An integer or float to compare.
Name
right
Required
required
Type
integer | float
Description
An integer or float to compare against.

Output

Name
value
Type
addon(std::assertion)
Description
The result of the assertion.

Example using assert_lte

output "assertion" { 
    value = std::assert_lte(action.example.result, 1)
}