fiktion-core/dev.s7a.fiktion

Package-level declarations

Types

Auto

data object Auto

Marker used by generates auto to request Fiktion's automatic generation.

CannotGenerateException

class CannotGenerateException(message: String, cause: Throwable? = null) : RuntimeException

Thrown when Fiktion cannot generate a value for the requested target.

CollectionGenerationSpec

sealed interface CollectionGenerationSpec<Element, CollectionType : Collection<Element>> : GenerationSpec<CollectionType>

Configured generation rule for collection values.

ExperimentalFiktionApi

@RequiresOptIn(message = "This Fiktion API is experimental and may change before 1.0.", level = RequiresOptIn.Level.WARNING)

annotation class ExperimentalFiktionApi

Marks APIs that are expected to evolve before Fiktion reaches 1.0.

FakeContext

interface FakeContext

Runtime context passed to custom generators.

FakeNullability

enum FakeNullability : Enum<FakeNullability>

Runtime nullability information for a generated property.

FakePath

data class FakePath(val segments: List<FakeProperty>)

Runtime path to a generated value.

FakeProperty

data class FakeProperty(val owner: FakeType, val name: String, val type: FakeType, val nullability: FakeNullability)

Runtime description of a generated property.

FakeSpec

class FakeSpec<Root>

Per-call configuration for generating a Root value.

FakeType

data class FakeType(val id: String, val displayName: String)

Runtime description of a generated type.

Fiktion

sealed interface Fiktion

Configured fake data generator.

FiktionAddon

interface FiktionAddon

Extension point that contributes reusable Fiktion rules.

FiktionAddonBuilder

sealed class FiktionAddonBuilder : FiktionRuleBuilder

Builder exposed to add-ons for contributing reusable low-precedence rules.

FiktionArrayMetadata

class FiktionArrayMetadata<T>(val type: KType, val elementType: KType, constructor: (List<Any?>) -> T) : FiktionTypeMetadata<T>

Runtime construction metadata for an array type that Fiktion can generate automatically.

FiktionBuilder

sealed class FiktionBuilder : FiktionRuleBuilder

Builder exposed when creating isolated Fiktion instances.

FiktionConfigurationException

class FiktionConfigurationException(message: String, cause: Throwable? = null) : IllegalArgumentException

Thrown when Fiktion configuration or DSL input is invalid.

FiktionConfigureBuilder

sealed class FiktionConfigureBuilder : FiktionBuilder

Builder exposed when updating the global Fiktion configuration.

FiktionEnumMetadata

class FiktionEnumMetadata<T : Enum<T>>(val type: KType, val entries: List<T>) : FiktionTypeMetadata<T>

Runtime construction metadata for an enum type.

FiktionObjectArgument

sealed interface FiktionObjectArgument

Constructor argument produced while generating an object.

FiktionObjectDefault

data object FiktionObjectDefault : FiktionObjectArgument

Constructor argument marker that asks generated metadata to use the property's default value.

FiktionObjectMetadata

class FiktionObjectMetadata<T>(val type: KType, val properties: List<FiktionObjectProperty>, constructor: (List<FiktionObjectArgument>) -> T) : FiktionTypeMetadata<T>

Runtime construction metadata for a type that Fiktion can generate automatically.

FiktionObjectProperty

data class FiktionObjectProperty(val name: String, val type: KType, val hasDefault: Boolean = false)

Runtime construction metadata for one generated object property.

FiktionObjectValue

data class FiktionObjectValue(val value: Any?) : FiktionObjectArgument

Constructor argument containing a generated value.

FiktionRuleBuilder

sealed class FiktionRuleBuilder

Shared rule registration surface exposed by Fiktion builders.

FiktionSealedMetadata

class FiktionSealedMetadata<T>(val type: KType, val subtypes: List<KType>) : FiktionTypeMetadata<T>

Runtime construction metadata for a sealed type.

FiktionSnapshot

sealed interface FiktionSnapshot

Restorable snapshot of the global Fiktion configuration.

FiktionTypeMetadata

sealed interface FiktionTypeMetadata<T>

Runtime metadata for a type that Fiktion can generate automatically.

FiktionValueMetadata

class FiktionValueMetadata<T>(val type: KType, val underlyingType: KType, constructor: (value: Any?) -> T) : FiktionTypeMetadata<T>

Runtime construction metadata for a value-like type backed by one generated value.

GenerationSpec

sealed interface GenerationSpec<out T>

Configured generation rule for values of T.

Generator

typealias Generator<T> = FakeContext.() -> T

Custom value generator executed with a FakeContext.

MapEntrySpec

sealed interface MapEntrySpec<Key, Value, MapType : Map<Key, Value>> : MapGenerationSpec<Key, Value, MapType>

Configured map rule that defines key and value generation.

MapGenerationSpec

sealed interface MapGenerationSpec<Key, Value, MapType : Map<Key, Value>> : GenerationSpec<MapType>

Configured generation rule for map values.

MapKeySpec

sealed interface MapKeySpec<Key, Value, MapType : Map<Key, Value>> : MapGenerationSpec<Key, Value, MapType>

Partially configured map rule that defines key generation.

MapValueSpec

sealed interface MapValueSpec<Key, Value, MapType : Map<Key, Value>> : MapGenerationSpec<Key, Value, MapType>

Partially configured map rule that defines value generation.

Probability

@JvmInline

value class Probability(val value: Double)

Probability value represented as a number from 0.0 to 1.0.

PropertyPath

class PropertyPath<Root, out Value>

Type-safe path from Root to a nested Value property.

RuleNameTarget

sealed interface RuleNameTarget

Target selected by a property-name rule before its value type is known.

RuleTarget

sealed interface RuleTarget<T>

Target selected by a rule declaration.

TypeFamilyGenerationContext

class TypeFamilyGenerationContext : FakeContext

Context for generating a value from the requested type's type arguments.

TypeFamilyGenerator

typealias TypeFamilyGenerator<T> = TypeFamilyGenerationContext.() -> T

Generator used by type-family rules.

TypeFamilyRuleTarget

sealed interface TypeFamilyRuleTarget<T>

Target selected by a type-family rule declaration.

Properties

auto

val auto: Auto

Requests Fiktion's automatic generation in rule declarations.

percent

val Double.percent: Probability

Converts this floating-point percentage to a Probability.

val Int.percent: Probability

Converts this integer percentage to a Probability.

Functions

andKeys

infix fun <Key, Value, MapType : Map<Key, Value>> MapValueSpec<Key, Value, MapType>.andKeys(generator: Generator<Key>): MapEntrySpec<Key, Value, MapType>

Completes this map rule by generating keys with generator.

andValues

infix fun <Key, Value, MapType : Map<Key, Value>> MapKeySpec<Key, Value, MapType>.andValues(generator: Generator<Value>): MapEntrySpec<Key, Value, MapType>

Completes this map rule by generating values with generator.

div

inline operator fun <Root, Intermediate : Any, Value> PropertyPath<Root, Intermediate?>.div(next: KProperty1<Intermediate, Value>): PropertyPath<Root, Value>

fun <Root, Intermediate : Any, Value> PropertyPath<Root, Intermediate?>.~~div~~(next: KProperty1<Intermediate, Value>, intermediate: KType, value: KType): PropertyPath<Root, Value>

Appends next to this property path.

inline operator fun <Root, Intermediate : Any, Value> KProperty1<Root, Intermediate?>.div(next: KProperty1<Intermediate, Value>): PropertyPath<Root, Value>

fun <Root, Intermediate : Any, Value> KProperty1<Root, Intermediate?>.~~div~~(next: KProperty1<Intermediate, Value>, root: KType, intermediate: KType, value: KType): PropertyPath<Root, Value>

Creates a nested property path using /.

fake

inline fun <T> fake(seed: Long? = null, noinline configure: FakeSpec<T>.() -> Unit = {}): T

Generates fake data for T using the global Fiktion configuration.

fun <T> ~~fake~~(type: KType, seed: Long? = null, configure: FakeSpec<T>.() -> Unit = {}): T

Generates fake data for T using the global Fiktion configuration and explicit type.

fake

inline fun <T> Fiktion.fake(seed: Long? = null, noinline configure: FakeSpec<T>.() -> Unit = {}): T

Generates fake data for T using this Fiktion instance.

fun <T> Fiktion.~~fake~~(type: KType, seed: Long? = null, configure: FakeSpec<T>.() -> Unit = {}): T

Generates fake data for T using this Fiktion instance and explicit type.

generatedArray

inline fun <T> generatedArray(elements: List<Any?>): Array<T>

Creates a typed array from compiler-generated array metadata.

generatedObjectArgumentUsesDefault

fun generatedObjectArgumentUsesDefault(arguments: List<FiktionObjectArgument>, index: Int): Boolean

Returns whether the generated constructor argument at index asks Kotlin to use the property's default value.

generatedObjectArgumentValue

fun generatedObjectArgumentValue(arguments: List<FiktionObjectArgument>, index: Int): Any?

Returns the generated constructor argument value at index.

generates

infix inline fun <T> RuleNameTarget.generates(value: T): GenerationSpec<T>

Generates value for this name target and infers the target value type from value.

infix fun <T> RuleTarget<T>.generates(value: T): GenerationSpec<T>

Generates value for this rule target.

infix fun <T> RuleTarget<T>.generates(auto: Auto): GenerationSpec<T>

Uses Fiktion's automatic generation for this rule target.

@JvmName(name = "generatesAutoCollection")

infix inline fun <Element, CollectionType : Collection<Element>> RuleTarget<CollectionType>.generates(auto: Auto): CollectionGenerationSpec<Element, CollectionType>

fun <Element, CollectionType : Collection<Element>> RuleTarget<CollectionType>.~~generates~~(auto: Auto, elementType: KType): CollectionGenerationSpec<Element, CollectionType>

Uses Fiktion's automatic generation for each element of this collection rule target.

@JvmName(name = "generatesAutoMap")

infix inline fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.generates(auto: Auto): MapGenerationSpec<Key, Value, MapType>

fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.~~generates~~(auto: Auto, keyType: KType?, valueType: KType?): MapGenerationSpec<Key, Value, MapType>

Uses Fiktion's automatic generation for each key and value of this map rule target.

generatesBy

infix inline fun <T> RuleNameTarget.generatesBy(noinline generator: Generator<T>): GenerationSpec<T>

Generates values for this name target and infers the target value type from generator.

infix fun <T> RuleTarget<T>.generatesBy(generator: Generator<T>): GenerationSpec<T>

Generates values for this rule target by invoking generator.

infix fun <T> TypeFamilyRuleTarget<T>.generatesBy(generator: TypeFamilyGenerator<T>): GenerationSpec<T>

Generates values for this type-family target by invoking generator.

generatesEach

infix fun <Element, CollectionType : Collection<Element>> RuleTarget<CollectionType>.generatesEach(generator: Generator<Element>): CollectionGenerationSpec<Element, CollectionType>

Generates each element for this collection rule target by invoking generator.

infix inline fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.generatesEach(noinline generator: Generator<Pair<Key, Value>>): MapEntrySpec<Key, Value, MapType>

fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.~~generatesEach~~(generator: Generator<Pair<Key, Value>>, keyType: KType?, valueType: KType?): MapEntrySpec<Key, Value, MapType>

Generates each entry for this map rule target by invoking generator.

generatesIn

@JvmName(name = "generatesByteIn")

infix fun RuleTarget<Byte>.generatesIn(range: IntRange): GenerationSpec<Byte>

Generates byte values within range.

infix fun RuleTarget<Char>.generatesIn(range: CharRange): GenerationSpec<Char>

Generates character values within range.

@JvmName(name = "generatesDoubleIn")

infix fun RuleTarget<Double>.generatesIn(range: ClosedFloatingPointRange<Double>): GenerationSpec<Double>

Generates double values within range.

@JvmName(name = "generatesFloatIn")

infix fun RuleTarget<Float>.generatesIn(range: ClosedFloatingPointRange<Float>): GenerationSpec<Float>

Generates float values within range.

infix fun RuleTarget<Int>.generatesIn(range: IntRange): GenerationSpec<Int>

Generates integer values within range.

infix fun RuleTarget<Long>.generatesIn(range: LongRange): GenerationSpec<Long>

Generates long values within range.

@JvmName(name = "generatesShortIn")

infix fun RuleTarget<Short>.generatesIn(range: IntRange): GenerationSpec<Short>

Generates short values within range.

@JvmName(name = "generatesUByteIn")

infix fun RuleTarget<UByte>.generatesIn(range: UIntRange): GenerationSpec<UByte>

Generates unsigned byte values within range.

infix fun RuleTarget<UInt>.generatesIn(range: UIntRange): GenerationSpec<UInt>

Generates unsigned integer values within range.

infix fun RuleTarget<ULong>.generatesIn(range: ULongRange): GenerationSpec<ULong>

Generates unsigned long values within range.

@JvmName(name = "generatesUShortIn")

infix fun RuleTarget<UShort>.generatesIn(range: UIntRange): GenerationSpec<UShort>

Generates unsigned short values within range.

generatesKeys

infix inline fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.generatesKeys(noinline generator: Generator<Key>): MapKeySpec<Key, Value, MapType>

fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.~~generatesKeys~~(generator: Generator<Key>, keyType: KType?, valueType: KType?): MapKeySpec<Key, Value, MapType>

Generates map keys for this rule target by invoking generator.

generatesOneOf

infix fun <T> RuleTarget<T>.generatesOneOf(values: Iterable<T>): GenerationSpec<T>

Generates one value from values.

generatesValues

infix inline fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.generatesValues(noinline generator: Generator<Value>): MapValueSpec<Key, Value, MapType>

fun <Key, Value, MapType : Map<Key, Value>> RuleTarget<MapType>.~~generatesValues~~(generator: Generator<Value>, keyType: KType?, valueType: KType?): MapValueSpec<Key, Value, MapType>

Generates map values for this rule target by invoking generator.