mokkery-runtime/dev.mokkery.matcher

Package-level declarations

Types

ArgMatcher

fun interface ArgMatcher<in T>

Checks if given argument satisfies provided conditions.

ArgMatchersScope

typealias ~~ArgMatchersScope~~ = MokkeryMatcherScope

Scope for declaring argument matchers.

MokkeryMatcherScope

interface MokkeryMatcherScope : MokkeryScope

Scope for declaring argument matchers.

Functions

any

fun <T> MokkeryMatcherScope.any(): T

Matches any argument.

fun <T> MokkeryMatcherScope.eq(value: T): T

DEPRECATED: This API is considered obsolete. Simply omit this matcher.

eqRef

fun <T> MokkeryMatcherScope.~~eqRef~~(value: T): T

DEPRECATED: Renamed to ref.

fun <T : Comparable<T>> MokkeryMatcherScope.gt(value: T): T

Matches argument that is greater than value.

gte

fun <T : Comparable<T>> MokkeryMatcherScope.gte(value: T): T

Matches an argument that is greater than or equal to value.

fun <T : Comparable<T>> MokkeryMatcherScope.lt(value: T): T

Matches argument that is less than value.

lte

fun <T : Comparable<T>> MokkeryMatcherScope.lte(value: T): T

Matches an argument that is less than or equal to value.

matches

fun <T> MokkeryMatcherScope.matches(matcher: ArgMatcher<T>): T

Matches argument that satisfies a matcher. Cannot be used with ArgMatcher.Composite. Use matchesComposite instead.

fun <T> MokkeryMatcherScope.matches(toString: () -> String, predicate: (T) -> Boolean): T

Matches an argument according to the predicate. Registered matcher Any.toString calls toString.

matchesBy

fun <T> MokkeryMatcherScope.matchesBy(function: (T) -> Boolean): T

Matches an argument by calling given function. Also, it returns function name on Any.toString.

matchesComposite

@DelicateMokkeryApi

fun <T : R, R> MokkeryMatcherScope.matchesComposite(vararg matchers: T, builder: (List<ArgMatcher<T>>) -> ArgMatcher.Composite<R>): R

Matches an argument that satisfies a matcher composed of matchers with builder.

matching

fun <T> MokkeryMatcherScope.~~matching~~(predicate: (T) -> Boolean): T

fun <T> MokkeryMatcherScope.~~matching~~(toString: () -> String, predicate: (T) -> Boolean): T

DEPRECATED: This API is considered obsolete. Use matches instead.

matchingBy

fun <T> MokkeryMatcherScope.~~matchingBy~~(function: (T) -> Boolean): T

DEPRECATED: Renamed to matchesBy

neq

fun <T> MokkeryMatcherScope.~~neq~~(value: T): T

Matches an argument that is not equal to value.

neqRef

fun <T> MokkeryMatcherScope.~~neqRef~~(value: T): T

Matches an argument whose reference is not equal to value's reference.

ofType

inline fun <T> MokkeryMatcherScope.ofType(): T

Matches an argument that is an instance of type T.

ref

fun <T> MokkeryMatcherScope.ref(value: T): T

Matches an argument whose reference is equal to value's reference.