mokkery-runtime/dev.mokkery.answering/SuspendAnsweringScope

SuspendAnsweringScope

interface SuspendAnsweringScope<T> : AnsweringScope<T>

Marker interface for defining an answer for suspend function call.

Inheritors

SuspendSequentialAnswerBuilder

Functions

answers

@DelicateMokkeryApi

abstract infix fun answers(answer: Answer<T>)

Registers given answer for a function call. Direct usage requires care, because it allows to register suspending answer for non-suspend function.

calls

infix fun <T> AnsweringScope<T>.calls(superCall: SuperCall)

Calls super method according to SuperCall.

infix fun <T> SuspendAnsweringScope<T>.calls(block: suspend SuspendCallDefinitionScope<T>.(CallArgs) -> T)

Suspend function call executes block.

callsCatching

infix fun <T> SuspendAnsweringScope<Result<T>>.callsCatching(block: suspend SuspendCallDefinitionScope<Result<T>>.(CallArgs) -> T)

Suspend function call executes block inside runCatching and returns Result. It rethrows any dev.mokkery.MokkeryRuntimeException as it indicates internal error and cannot be ignored.

returns

infix fun <T> AnsweringScope<T>.returns(value: T)

Function call always returns value.

returnsArgAt

infix fun <T> AnsweringScope<T>.returnsArgAt(index: Int)

Function call returns argument at index.

returnsBy

infix fun <T> AnsweringScope<T>.returnsBy(function: () -> T)

Function call returns value provided each time by function.

returnsFailure

infix fun <T> AnsweringScope<in Result<T>>.returnsFailure(error: Throwable)

Function call returns Result.failure with error.

returnsFailureBy

infix fun <T> AnsweringScope<in Result<T>>.returnsFailureBy(function: () -> Throwable)

Function call returns Result.failure with exception provided each time by function.

returnsSuccess

infix fun <T> AnsweringScope<in Result<T>>.returnsSuccess(value: T)

Function call returns Result.success with value.

returnsSuccessBy

infix fun <T> AnsweringScope<in Result<T>>.returnsSuccessBy(function: () -> T)

Function call returns Result.success with value provided each time by function.

sequentially

infix fun <T> SuspendAnsweringScope<T>.sequentially(block: SuspendSequentialAnswerBuilder<T>.() -> Unit)

Function call will answer sequentially with answers defined in block.

sequentiallyRepeat

infix fun <T> SuspendAnsweringScope<T>.sequentiallyRepeat(block: SuspendSequentialAnswerBuilder<T>.() -> Unit)

Simplification for SuspendAnsweringScope.sequentially with repeat.

sequentiallyReturns

infix fun <T> AnsweringScope<T>.sequentiallyReturns(values: Iterable<T>)

Simplification for sequentially with multiple returns calls.

sequentiallyThrows

infix fun <T> AnsweringScope<T>.sequentiallyThrows(errors: Iterable<Throwable>)

Simplification for sequentially with multiple throws calls.

throws

infix fun <T> AnsweringScope<T>.throws(error: Throwable)

Function call always throws error.

throwsBy

infix fun <T> AnsweringScope<T>.throwsBy(function: () -> Throwable)

Function call throws exception provided each time by function.

throwsErrorWith

infix fun <T> AnsweringScope<T>.throwsErrorWith(message: Any)

Function call always throws an IllegalStateException with given message.