arrow-analysis-types/arrow.analysis

Package arrow.analysis

Types

DoNotLookAtArguments

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DoNotLookAtArguments( val messages: Array<String>, val formulae: Array<String>, val dependencies: Array<String>)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Law

Annotation to flag ad-hoc refinements over third party functions

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Laws

This is used to mark an object as containing only laws. This way you do not have to write the annotation on every element, and you can group several of them together.

fun interface Messager

PackagesWithLaws

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PackagesWithLaws(val packages: Array<String>)

This is used internally to speed up the search for laws Each package with any law should include this annotation in a class of module 'arrow.analysis.hints'

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Post( val messages: Array<String>, val formulae: Array<String>, val dependencies: Array<String>)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Pre( val messages: Array<String>, val formulae: Array<String>, val dependencies: Array<String>)

fun interface Predicate<A>

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Subject(val fqName: String)

Annotation to flag ad-hoc refinements over third party functions

Functions

doNotLookAtArgumentsWhen

inline fun doNotLookAtArgumentsWhen(predicate: Boolean, msg: Messager)

inline fun <A> A.invariant(predicate: Predicate<A>, msg: Messager): A

inline fun <A> post(predicate: Predicate<A>, msg: Messager)

inline fun <A> A.post(predicate: Predicate<A>, msg: Messager): A

inline fun pre(predicate: Boolean, msg: Messager)

inline fun <A> unsafeBlock(block: () -> A): A

Indicates that nothing in this block should be checked.

inline fun <A> unsafeCall(call: A): A

Indicates that the preconditions for a call should not be checked.