client-scanner/io.github.octaviusframework.client.scanner/ScanReport

ScanReport

data class ScanReport(val enums: List<RegisteredType>, val composites: List<RegisteredType>, val dynamicTypes: List<RegisteredType>, val unresolved: List<RegisteredType> = emptyList())

What a scan found and registered. Worth logging or checking at startup: a mistyped package registers nothing and raises nothing.

Constructors

constructor(enums: List<RegisteredType>, composites: List<RegisteredType>, dynamicTypes: List<RegisteredType>, unresolved: List<RegisteredType> = emptyList())

Properties

val composites: List<RegisteredType>

Data classes registered as PostgreSQL COMPOSITE types.

val dynamicTypes: List<RegisteredType>

Classes registered as dynamic_dto discriminators.

val enums: List<RegisteredType>

Enums registered as PostgreSQL ENUM types.

How many classes were registered in total.

val unresolved: List<RegisteredType>

The enums and composites whose type the database does not have. They are registered all the same and appear in enums or composites too: either the name is wrong, or the type is created later and maps once reloadTypes() has run.

Functions

fun isEmpty(): Boolean

Whether the scan registered nothing at all.

open override fun toString(): String