jqwik-kotlin/net.jqwik.kotlin.api

Package net.jqwik.kotlin.api

Types

Link copied to clipboard
data class IntRangeArbitrary(    min: Int,     max: Int,     minSize: Int,     maxSize: Int) : ArbitraryDecorator<IntRange> , SizableArbitrary<IntRange>
Content copied to clipboard
Link copied to clipboard
typealias JqwikCharRange = CharRange
Content copied to clipboard
Link copied to clipboard
typealias JqwikIntRange = IntRange
Content copied to clipboard
Link copied to clipboard
typealias JqwikLongRange = LongRange
Content copied to clipboard
Link copied to clipboard
typealias JqwikShortRange = ShortRange
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
class SequenceArbitrary<T>(elementArbitrary: Arbitrary<T>) : ArbitraryDecorator<Sequence<T>> , SizableArbitrary<Sequence<T>>
Content copied to clipboard

Fluent interface to add functionality to arbitraries that generate instances of type Sequence

Functions

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Boolean.Companion.any(): Arbitrary<Boolean>
Content copied to clipboard

Convenience function to create an arbitrary for Boolean.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Byte.Companion.any(): ByteArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Byte.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Char.Companion.any(): CharacterArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Char.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Double.Companion.any(): DoubleArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Double.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
inline fun <T : Enum<T>> Enum.Companion.any(): Arbitrary<T>
Content copied to clipboard

Function to create arbitrary for all values of an enum type.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Float.Companion.any(): FloatArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Float.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Int.Companion.any(): IntegerArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Int.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Long.Companion.any(): LongArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Long.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Short.Companion.any(): ShortArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Short in a range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun String.Companion.any(): StringArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for String.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun IntRange.Companion.any(): IntRangeArbitrary
Content copied to clipboard

Function to create an arbitrary for IntRange.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Byte.Companion.any(range: IntRange): ByteArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Byte in a range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Char.Companion.any(range: CharRange): CharacterArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Char in range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Double.Companion.any(range: ClosedFloatingPointRange<Double>): DoubleArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Double in range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Float.Companion.any(range: ClosedFloatingPointRange<Float>): FloatArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Float in range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Int.Companion.any(range: IntRange): IntegerArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Int in range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Long.Companion.any(range: LongRange): LongArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Long in range.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun Short.Companion.any(range: IntRange): ShortArbitrary
Content copied to clipboard

Convenience function to create an arbitrary for Short.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun IntRange.Companion.any(range: IntRange): IntRangeArbitrary
Content copied to clipboard

Function to create an arbitrary for IntRange with range.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
inline fun <T> anyForType(): TypeArbitrary<T>
Content copied to clipboard

Function to create a TypeArbitrary.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun anyFunction(kClass: KClass<*>): Functions.FunctionWrapper
Content copied to clipboard

Function to create a FunctionWrapper.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <R> anyFunction0(returning: Arbitrary<R>): FunctionArbitrary<() -> R, R>
Content copied to clipboard

Create a FunctionArbitrary for Kotlin function without parameters.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, R> anyFunction1(returning: Arbitrary<R>): FunctionArbitrary<(A) -> R, R>
Content copied to clipboard

Create a FunctionArbitrary for Kotlin function with 1 parameter.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, B, R> anyFunction2(returning: Arbitrary<R>): FunctionArbitrary<(A, B) -> R, R>
Content copied to clipboard

Create a FunctionArbitrary for Kotlin function with 2 parameters.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, B, C, R> anyFunction3(returning: Arbitrary<R>): FunctionArbitrary<(A, B, C) -> R, R>
Content copied to clipboard

Create a FunctionArbitrary for Kotlin function with 3 parameters.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, B, C, D, R> anyFunction4(returning: Arbitrary<R>): FunctionArbitrary<(A, B, C, D) -> R, R>
Content copied to clipboard

Create a FunctionArbitrary for Kotlin function with 4 parameters.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, B> anyPair(firstArbitrary: Arbitrary<A>, secondArbitrary: Arbitrary<B>): Arbitrary<Pair<A, B>>
Content copied to clipboard

Function to create an arbitrary for Pair.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.5")
fun <T> Collection<T>.anySubset(): SetArbitrary<T>
Content copied to clipboard

Convenience function to replace Arbitraries.subsetOf(..)

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <A, B, C> anyTriple(    firstArbitrary: Arbitrary<A>,     secondArbitrary: Arbitrary<B>,     thirdArbitrary: Arbitrary<C>): Arbitrary<Triple<A, B, C>>
Content copied to clipboard

Function to create an arbitrary for Triple.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
inline fun <T, A> Arbitrary<T>.array(): ArrayArbitrary<T, A>
Content copied to clipboard

Create a new arbitrary of type Array using the existing arbitrary for generating the elements of the array.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T, R> combine(arbitraries: List<Arbitrary<T>>, combinator: (v1: List<T>) -> R): Arbitrary<R>
Content copied to clipboard

Combine list of arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     combinator: (v1: T1, v2: T2) -> R): Arbitrary<R>
Content copied to clipboard

Combine 2 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     combinator: (v1: T1, v2: T2, v3: T3) -> R): Arbitrary<R>
Content copied to clipboard

Combine 3 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     combinator: (v1: T1, v2: T2, v3: T3, v4: T4) -> R): Arbitrary<R>
Content copied to clipboard

Combine 4 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5) -> R): Arbitrary<R>
Content copied to clipboard

Combine 5 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6) -> R): Arbitrary<R>
Content copied to clipboard

Combine 6 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     a7: Arbitrary<T7>,     combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7) -> R): Arbitrary<R>
Content copied to clipboard

Combine 7 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, T8, R> combine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     a7: Arbitrary<T7>,     a8: Arbitrary<T8>,     combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8) -> R): Arbitrary<R>
Content copied to clipboard

Combine 8 arbitraries into one.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A> Tuple.Tuple1<A>.component1(): A
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B> Tuple.Tuple2<A, B>.component2(): B
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C> Tuple.Tuple3<A, B, C>.component3(): C
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C, D> Tuple.Tuple4<A, B, C, D>.component4(): D
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C, D, E> Tuple.Tuple5<A, B, C, D, E>.component5(): E
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C, D, E, F> Tuple.Tuple6<A, B, C, D, E, F>.component6(): F
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C, D, E, F, G> Tuple.Tuple7<A, B, C, D, E, F, G>.component7(): G
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
operator fun <A, B, C, D, E, F, G, H> Tuple.Tuple8<A, B, C, D, E, F, G, H>.component8(): H
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T, R> flatCombine(arbitraries: List<Arbitrary<T>>, flatCombinator: (v1: List<T>) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine list of arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     flatCombinator: (v1: T1, v2: T2) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 2 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     flatCombinator: (v1: T1, v2: T2, v3: T3) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 3 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     flatCombinator: (v1: T1, v2: T2, v3: T3, v4: T4) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 4 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     flatCombinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 5 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     flatCombinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 6 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     a7: Arbitrary<T7>,     flatCombinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 7 arbitraries into one.

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, T8, R> flatCombine(    a1: Arbitrary<T1>,     a2: Arbitrary<T2>,     a3: Arbitrary<T3>,     a4: Arbitrary<T4>,     a5: Arbitrary<T5>,     a6: Arbitrary<T6>,     a7: Arbitrary<T7>,     a8: Arbitrary<T8>,     flatCombine: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8) -> Arbitrary<R>): Arbitrary<R>
Content copied to clipboard

Flat-combine 8 arbitraries into one.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.2")
fun <T> frequency(vararg frequencies: Pair<Int, T>): Arbitrary<T>
Content copied to clipboard

Function to create arbitrary that generates one of the provided values with a given frequency.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.2")
fun <T> frequencyOf(vararg frequencies: Pair<Int, Arbitrary<out T>>): Arbitrary<T>
Content copied to clipboard

Function to choose from one of the provided arbitraries with a given frequency.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun TypeUsage.isAssignableFrom(kClass: KClass<*>): Boolean
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun StringArbitrary.ofLength(range: IntRange): StringArbitrary
Content copied to clipboard

Set the minimum and maximum allowed length of generated strings.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T, A> ArrayArbitrary<T, A>.ofSize(range: IntRange): ArrayArbitrary<T, A>
Content copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> IteratorArbitrary<T>.ofSize(range: IntRange): IteratorArbitrary<T>
Content copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> ListArbitrary<T>.ofSize(range: IntRange): ListArbitrary<T>
Content copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <K, V> MapArbitrary<K, V>.ofSize(range: IntRange): MapArbitrary<K, V>
Content copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> SetArbitrary<T>.ofSize(range: IntRange): SetArbitrary<T>
Content copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> StreamArbitrary<T>.ofSize(range: IntRange): StreamArbitrary<T>
Content copied to clipboard
Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> Arbitrary<T>.orNull(nullProbability: Double): Arbitrary<T?>
Content copied to clipboard

Create a new arbitrary of the same type but inject null values with a probability of nullProbability.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> Arbitrary<T>.pair(): Arbitrary<Pair<T, T>>
Content copied to clipboard

Create a new arbitrary for type Pair using the existing arbitrary for generating the elements of the pair.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> runBlockingProperty(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T
Content copied to clipboard

Wrap a property so that it can use asynchronous functions within.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> Arbitrary<T>.sequence(): SequenceArbitrary<T>
Content copied to clipboard

Create a new arbitrary of type SequenceArbitrary using the existing arbitrary for generating the elements of the sequence.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T> Arbitrary<T>.triple(): Arbitrary<Triple<T, T, T>>
Content copied to clipboard

Create a new arbitrary for type Triple using the existing arbitrary for generating the elements of the triple.

Link copied to clipboard
@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <B, T> Builders.BuilderCombinator<B>.use(arbitrary: Arbitrary<T>, combinator: (B, T) -> B): Builders.BuilderCombinator<B>
Content copied to clipboard

Convenience function for Kotlin to not use backticked in function.

Properties

Link copied to clipboard
val TypeUsage.kotlinType: KType?
Content copied to clipboard