yamlkt

0.13.0indexed

Fast YAML library with comments support. Offers deserialization to structured objects, contextual and polymorphic serialization, dynamic types handling, and `YamlElement` wrapper classes. Missing support for anchors and certain multiline strings.

JSJVMNative·Him188/yamlkt

160

Stars

Used by

dependents

—

Health

/ 100

YamlKt

Gradle CI

Fast multi-platform YAML with comments support for kotlinx.serialization

This project is in alpha state.

Setup

Third-party formats for kotlinx.serialization is strongly dependent on the versions of kotlinx-serialization-core and Kotlin compiler.

The table below shows recommended version parings. Note that normally you may use higher versions within the minor version range, e.g. preferring 1.3.3 or 1.3.0 over 1.3.2.

Gradle

repositories {
    mavenCentral()
}

dependencies {
    implementation("net.mamoe.yamlkt:yamlkt:0.13.0")
}

If your project is multiplatform, you need only to add this dependency for commonMain:

commonMain {
    dependencies {
        implementation("net.mamoe.yamlkt:yamlkt:0.13.0")
    }
}

Maven

Only JVM target is available for Maven.

<dependency>
    <groupId>net.mamoe.yamlkt</groupId>
    <artifactId>yamlkt-jvm</artifactId>
    <version>0.13.0</version>
</dependency>

Overview

This library supports:

fast deserializing YAML text to a structured object
contextual and polymorphic serialization: @Contextual, @Polymorphic

The features that aren't yet supported:

Anchors (*, &)
Explicit types (e.g. !!map)
Multiline string (| and > are partially supported; \ is not)

Usage

Serialize / deserialize with compiled serializers

This is the fastest and recommended way.

@Serializable
data class Test(
    val test: String,
    val optional: String = "optional", // Having default value means optional
    val nest: Nested,
    val list: List<String>
) {
    @Serializable
    data class Nested(
         numberCast: 
    )
}

println(Yaml.parse(Test.serializer(), ))

Contextual serializing / deserializing

YamlKt provides a contextual serializer YamlDynamicSerializer for Any
and YamlNullDynamicSerializer for Any?

By default, YamlDynamicSerializer is installed to Any.
You can start by using @Contextual:

@Serializable
data class Test(
    val any: @Contextual Any
)

Yaml.parse(Test.serializer(), yamlText)

For input YAML text:

test: { key1: v1, key2: [v2, v3, v4] }

Alternatively, you can deserialize without any class:

val map: Map<String?, Any?> = Yaml.parseMap("""test: { key1: v1, key2: [v2, v3, v4] }""")

`YamlElement`

YamlElement is a type-safe way to deserialize without descriptors.

val map: YamlMap = Yaml.decodeYamlMapFromString("""test: { key1: v1, key2: [v2, v3, v4] }""")

Comments

Annotate your comments to a field(property) using @Comment:
Example:

@Serializable
data class User(
  @Comment("The name of the user")
  val name: String = "value"
)

gives yaml text:

# The name of the user
name: ""

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

datastore★ 6.0k

androidxAsynchronous, consistent, transactional storage replacing SharedPreferences; supports preferences and typed objects with Proto/JSON serialization, optional Rx adapters, and atomic updates.Shared: serialization

kaml★ 586

charleskornAdds YAML support to a serialization library, enabling parsing and serializing YAML to objects and vice versa. Supports major YAML features, polymorphism, and Docker Compose-style extension fields.Shared: serialization

ktoml★ 558

orchestr7Serialization/deserialization library for TOML configuration files. Supports various data types, including nested structures, partial deserialization, and file-based operations. Configurable parsing and serialization options.Shared: serialization

xmlutil★ 492

pdvriezeSupports cross-platform XML serialization and parsing with automatic object serialization and custom policies. Includes modules for core functionality, serialization, and native XML parsing support.Shared: serialization

kotlin-multiplatform-bignum★ 475

ionspinImplements arbitrary precision arithmetic operations, including integers and floating-point numbers. Offers extensive functionality like basic arithmetic, bitwise operations, and modular arithmetic. Also supports serialization and various rounding modes.Shared: serialization

pbandk★ 296

streemGenerates and manages code for Protocol Buffers with features like clean data class generation, JSON serialization, oneof handling as sealed classes, and support for proto2 and proto3 syntaxes.Shared: serialization

0.3.3	1.3.70	0.20.0
0.5.3	1.4.0	1.0.0-RC
0.6.0	1.4.10	1.0.0-RC2
0.8.0	1.4.10	1.0.1
0.9.0	1.4.30	1.1.0-RC
0.10.2	1.5.20	1.2.1
0.10.2	1.5.31	1.3.0
0.11.0	1.6.21	1.3.3
0.12.0	1.6.21	1.3.3
0.12.0	1.7.10	1.3.3
0.13.0	1.8.0	1.5.0