kotlin-stdlib/kotlin.contracts/ContractBuilder

ContractBuilder

@ExperimentalContracts
interface ContractBuilder(source)

Provides a scope, where the functions of the contract DSL, such as returns, callsInPlace, etc., can be used to describe the contract of a function.

This type is used as a receiver type of the lambda function passed to the contract function.

Since Kotlin

1.3

See also

Functions

Link copied to clipboard
abstract fun <R> callsInPlace(lambda: Function<R>, kind: InvocationKind = InvocationKind.UNKNOWN): CallsInPlace

Specifies that the function parameter lambda is invoked in place.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalExtendedContracts
abstract infix fun <R> Boolean.holdsIn(lambda: Function<R>): HoldsIn

Specifies the condition, passed as a receiver argument, that is guaranteed to be true in the body of a function parameter lambda.

Since Kotlin 2.2
Link copied to clipboard
@ExperimentalExtendedContracts
abstract infix fun Boolean.implies(value: ReturnsNotNull)

Specifies the effect that will be observed if the condition passed as a receiver argument holds.

Since Kotlin 2.2
Link copied to clipboard
abstract fun returns(): Returns

Describes a situation when a function returns normally, without any exceptions thrown.

Since Kotlin 1.3
abstract fun returns(value: Any?): Returns

Describes a situation when a function returns normally with the specified return value.

Since Kotlin 1.3
Link copied to clipboard
abstract fun returnsNotNull(): ReturnsNotNull

Describes a situation when a function returns normally with any value that is not null.

Since Kotlin 1.3
Link copied to clipboard
abstract fun <R> returnsResultOf(lambda: Function<R>)

Specifies that the function returns the result of the invocation of the function parameter lambda.

Since Kotlin 2.4