Documentation

A stub rule with no transitions to use as a placeholder

This can be used to specify predicate failures in STS rules where a value is beyond a certain threshold.

TODO move this somewhere more sensible

Control which predicates are evaluated during rule processing.

Control which assertions are enabled.

Label for a predicate. This can be used to control which predicates get run.

Embed one STS within another.

State transition system.

An assertion is a validation condition for the STS system in question. It should be used to define properties of the system as a whole that cannot be violated under normal circumstances - e.g. a violation implies a failing in the rule logic.

Assertions should not check for conditions that may differ between different rules in a system, since the interpreter may stop the system upon presence of a failed assertion.

Whether assertions are checked is a matter for the STS interpreter.

Context available to transition rules.

Context available to initial rules.

Map over an arbitrary EventReturnType.

Fail with PredicateFailure's in STS if Validation was unsuccessful.

Same as validation, except with ability to transform opaque failures into PredicateFailures with a help of supplied function.

Same as validation, except with ability to translate opaque failures into PredicateFailures with a help of supplied function.

Oh noes!

This takes a condition (a boolean expression) and a failure and results in a clause which will throw that failure if the condition fails.

Produce a predicate failure when condition contains a Just value, contents of which can be used inside the predicate failure

Produce a failure when condition contains a Just value, contents of which can be used inside the failure

Produce a predicate failure when supplied foldable is not empty, contents of which will be converted to a NonEmpty list and can be used inside the predicate failure.

Produce a failure when supplied foldable is not empty, contents of which will be converted to a NonEmpty list and theh can be used inside the failure.

Oh noes with an explanation

We interpret this as "What?" "No!" "Because:"

Labeled predicate. This may be used to control which predicates are run using ValidateSuchThat.

Labeled predicate with an explanation

Labeled clause. This will only be executed if the interpreter is set to execute clauses with this label.

Get the judgment context

Apply an STS with options. Note that this returns both the final state and the list of predicate failures.

Re-apply an STS.

It is assumed that the caller of this function has previously applied this STS, and can guarantee that it completed successfully. No predicates or assertions will be checked when calling this function.

Apply a rule even if its predicates fail.

If the rule successfully applied, the list of predicate failures will be empty.

sfor_ is straverse_ with its arguments flipped. For a version that doesn't ignore the results see for.

>>> sfor_ ([1..4] :: [Int]) print
1
2
3
4

runRule :: RuleInterpreter 'EventPolicyDiscard run a rule given its context, to get a BaseM computation