KotlinX Serialization Standard Serializers (KS3)
This project aims to provide a set of serializers for common types.
⚠️ Consider this project to be Alpha for the time being. We would be happy for you to use it, and appreciate your feedback, but things may be re-written. We hope to reach Beta relatively quick.
Getting started
Add the dependency. With Gradle:
dependencies {
implementation("io.ks3:ks3-jdk:<version>")
}
Maven:
<dependency>
<groupId>io.ks3</groupId>
<artifactId>ks3-jdk-jvm</artifactId>
<version>0.0.2</version>
</dependency>
Note that when using Maven dependencies must specify the multiplatform variant. For example, append
-jvmto specify the JVM variant ofks3-jdk.
Now you can start using the provided serializers. There's several possible ways to do this.
- Using contextual serialization
- Passing a serializer manually
- Specifying serializer on a property
- Specifying serializers for a file
- Specifying serializer using a typealias
Using typealias
typealias LocalDateTimeAsString = @Serializable(LocalDateTimeAsStringSerializer::class) LocalDateTime
data class Appointment(
val datetime: LocalDateTimeAsString
)
For details, see the kotlinx.serialization guide
This method is most useful when you want to use different serial formats for the same type, or when you can't configure the serializer itself.
Using @Contextual
See the details in kotlinx.serialization guide
@Serializable
class ProgrammingLanguage(
val name: String,
@Contextual
val stableReleaseDate: Date
)
private val module = SerializersModule {
contextual(DateAsLongSerializer)
}
val format = Json { serializersModule = module }
69 Nov 9, 2022
41 Dec 21, 2022
50 Nov 20, 2022
12 Dec 16, 2022
32 Jan 4, 2023
98 Jan 3, 2023
14 Nov 5, 2022
19 Sep 8, 2022
132 Dec 9, 2022
34 Dec 30, 2022
30 Dec 27, 2022
23 Dec 27, 2022
148 Jan 8, 2023
1 May 6, 2022
0 Apr 20, 2022
2 May 29, 2022
5 Mar 31, 2022