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

KlibDump

Represents KLib ABI dump and allows manipulating it.

Usual KlibDump workflows consists of loading, updating and writing a dump back.

Creating a textual dump from a klib

val dump = KlibDump.fromKlib(File("/path/to/library.klib"))
dump.saveTo(File("/path/to/dump.klib.api"))

Loading a dump

val dump = KlibDump.from(File("/path/to/dump.klib.api"))

Merging multiple dumps into a new merged dump

val klibs = listOf(File("/path/to/library-linuxX64.klib"), File("/path/to/library-linuxArm64.klib"), ...)
val mergedDump = KlibDump()
klibs.forEach { mergedDump.mergeFromKlib(it) }
mergedDump.saveTo(File("/path/to/merged.klib.api"))

Updating an existing merged dump

val mergedDump = KlibDump.from(File("/path/to/merged.klib.api"))
val newTargetDump = KlibDump.fromKlib(File("/path/to/library-linuxX64.klib"))
mergedDump.remove(newTargetDump.targets)
mergedDump.merge(newTargetDump)
mergedDump.saveTo(File("/path/to/merged.klib.api"))