binary-compatibility-validator/kotlinx.validation.api.klib

Package-level declarations

Provides an API for dumping Kotlin libraries (KLibs) public ABI and managing resulting dumps.

This package is experimental, both API and behaviour may change in the future. There are also no guarantees on preserving the behavior of the API until its stabilization.

Types

KlibDump

class KlibDump

Represents KLib ABI dump and allows manipulating it.

KlibDumpFilters

class KlibDumpFilters

Filters affecting how the klib ABI will be represented in a dump.

KlibSignatureVersion

class KlibSignatureVersion

KlibTarget

class KlibTarget

Target name consisting of two parts: a configurableName that could be configured by a user, and an targetName that names a target platform and could not be configured by a user.

Functions

inferAbi

fun inferAbi(unsupportedTarget: KlibTarget, supportedTargetDumps: Iterable<KlibDump>, oldMergedDump: KlibDump? = null): KlibDump

Infer a possible public ABI for unsupportedTarget as an ABI common across all supportedTargetDumps. If there's an oldMergedDump consisting of declarations of multiple targets, including unsupportedTarget, a portion of that dump specific to the unsupportedTarget will be extracted and merged to the common ABI build from supportedTargetDumps.

KLibDumpFilters

fun KLibDumpFilters(builderAction: KlibDumpFilters.Builder.() -> Unit): KlibDumpFilters

Builds a new KlibDumpFilters instance by invoking a builderAction on a temporary KlibDumpFilters.Builder instance and then converting it into filters.

mergeFromKlib

fun KlibDump.mergeFromKlib(klibFile: File, configurableTargetName: String? = null, filters: KlibDumpFilters = KlibDumpFilters.DEFAULT)

Dumps a public ABI of a klib represented by klibFile using filters and merges it into this dump.

saveTo

fun KlibDump.saveTo(file: File)

Serializes the dump and writes it to file.