Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.92 KB

README.md

File metadata and controls

80 lines (60 loc) · 2.92 KB
Raw

Apache Fury™ Kotlin

This provides additional Fury support for Kotlin Serialization on JVM:

Most standard kotlin types are already supported out of the box with the default Fury java implementation.

Fury Kotlin provides additional tests and implementation support for Kotlin types.

Fury Kotlin is tested and works with the following types:

  • primitives: Byte, Boolean, Int, Short, Long, Char, Float, Double, UByte, UShort, UInt, ULong.
  • Byte, Boolean, Int, Short, Long, Char, Float, Double works out of the box with the default fury java implementation.
  • stdlib collection: ArrayDeque, ArrayList, HashMap,HashSet, LinkedHashSet, LinkedHashMap.
  • ArrayList, HashMap,HashSet, LinkedHashSet, LinkedHashMap works out of the box with the default fury java implementation.
  • String works out of the box with the default fury java implementation.
  • arrays: Array, BooleanArray, ByteArray, CharArray, DoubleArray, FloatArray, IntArray, LongArray, ShortArray
  • all standard array types work out of the box with the default fury java implementation.
  • unsigned arrays: UByteArray, UShortArray, UIntArray, ULongArray
  • from stdlib: Pair, Triple, Result
  • kotlin.random: Random
  • kotlin.ranges: CharRange, CharProgression, IntRange, IntProgression, LongRange, LongProgression, UintRange, UintProgression, ULongRange, ULongProgression
  • kotlin.text: Regex
  • kotlin.time: Duration
  • kotlin.uuid: Uuid

Additional support is added for the following classes in kotlin:

  • Unsigned primitives: UByte, UShort, UInt, ULong
  • Unsigned array types: UByteArray, UShortArray, UIntArray, ULongArray
  • Empty collections: emptyList, emptyMap, emptySet
  • Collections: ArrayDeque
  • kotlin.time: Duration
  • kotlin.uuid: Uuid

Additional Notes:

  • wrappers classes created from withDefault method is currently not supported.

Quick Start

import org.apache.fury.Fury
import org.apache.fury.ThreadSafeFury
import org.apache.fury.serializer.kotlin.KotlinSerializers

data class Person(val name: String, val id: Long, val github: String)
data class Point(val x : Int, val y : Int, val z : Int)

fun main(args: Array<String>) {
    // Note: following fury init code should be executed only once in a global scope instead
    // of initializing it everytime when serialization.
    val fury: ThreadSafeFury = Fury.builder().requireClassRegistration(true).buildThreadSafeFury()
    KotlinSerializers.registerSerializers(fury)
    fury.register(Person::class.java)
    fury.register(Point::class.java)

    val p = Person("Shawn Yang", 1, "https://github.com/chaokunyang")
    println(fury.deserialize(fury.serialize(p)))
    println(fury.deserialize(fury.serialize(Point(1, 2, 3))))
}

Building Fury Kotlin

mvn clean
mvn -T10 compile

Code Format

mvn -T10 spotless:apply

Testing

mvn -T10 test