Implements type-safe union types with serialization, supporting up to 23 different types. Offers pattern matching-like behavior, safe and unsafe union creation, and extensive cross-platform capabilities.
A Kotlin Multiplatform library that provides a type-safe union type implementation with serialization support.
consume functionsrepositories {
mavenCentral()
}
dependencies {
implementation("io.github.stream29:kunion:0.0.3")
}
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.stream29:kunion:0.0.3'
}
<dependency>
<groupId>io.github.stream29</groupId>
<artifactId>kunion</artifactId>
<version>0.0.3</version>
</dependency>
You can create a union using the SafeUnion or UnsafeUnion functions:
// Safe union creation (checks that the value is of one of the expected types)
val stringOrInt: Union2<String, Int> = SafeUnion2<String, Int>("Hello")
val intOrString: Union2<Int, String> = SafeUnion2<Int, String>(42)
// Unsafe union creation (no type checking)
val unsafeUnion: Union2<String, Int> = UnsafeUnion("Hello")
You can consume a union using the consume functions:
val union: Union2<String, Int> = SafeUnion2<String, Int>("Hello")
// Pattern matching-like behavior
union
.consume0 { str -> println("String: $str") }
.consume1 { int -> println("Int: $int") }
KUnion supports serialization via kotlinx.serialization:
val union: Union2<String, Int> = SafeUnion2<String, Int>("Hello")
val json = Json.encodeToString(union) // Serializes to JSON
val deserialized = Json.decodeFromString<Union2<String, Int>>(json) // Deserializes from JSON
fun processValue(value: Union2<String, Int>) {
value
.consume0 { str -> println() }
.consume1 { int -> println() }
}
{
stringValue = SafeUnion2<String, >()
intValue = SafeUnion2<String, >()
processValue(stringValue)
processValue(intValue)
}
KUnion is licensed under the Apache License Version 2.0. See the LICENSE file for details.
sealed class Result
data class Success(val data: String) : Result()
data class Error(val message: String) : Result()
data class Loading(val progress: Int) : Result()
fun handleResult(result: Union3<Success, Error, Loading>) {
result
.consume0 { success -> println("Success: ${success.data}") }
.consume1 { error -> println("Error: ${error.message}") }
.consume2 { loading -> println("Loading: ${loading.progress}%") }
}
fun main() {
val success = SafeUnion3<Success, Error, Loading>(Success("Data loaded"))
val error = SafeUnion3<Success, Error, Loading>(Error("Failed to load data"))
val loading = SafeUnion3<Success, Error, Loading>(Loading(75))
handleResult(success) // Prints: Success: Data loaded
handleResult(error) // Prints: Error: Failed to load data
handleResult(loading) // Prints: Loading: 75%
}
Surfaced from shared tags and platforms — no rankings paid for.