assertions(Mode) — Logtalk 3.100.1

object

# `assertions(Mode)`

A simple assertions framework. Can be used as a hook object for either suppressing assertions (`production` mode) or expanding them with file context information (`debug` mode).

Availability:
`logtalk_load(assertions(loader))`
Author: Paulo Moura
Version: 2:2:2
Date: 2022-07-04
Compilation flags:
`static, context_switching_calls`
Implements:
`public` expanding
Uses:
logtalk
Remarks:
(none)
Inherited public predicates:
goal_expansion/2 term_expansion/2

## Public predicates

### `assertion/1`

Checks that an assertion is true. Uses the structured message printing mechanism for printing the results using a silent message for assertion success and a error message for assertion failure.

Compilation flags:
`static`
Template:
`assertion(Goal)`
Meta-predicate template:
`assertion(0)`
Mode and number of proofs:
`assertion(@callable)` - `one`

### `assertion/2`

Checks that an assertion is true. Uses the structured message printing mechanism for printing the results using a silent message for assertion success and a error message for assertion failure. The context argument can be used to e.g. pass location data.

Compilation flags:
`static`
Template:
`assertion(Context,Goal)`
Meta-predicate template:
`assertion(*,0)`
Mode and number of proofs:
`assertion(@term,@callable)` - `one`

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

(no local declarations; see entity ancestors if any)

## Operators

(none)