flatbuffers-kotlin/com.google.flatbuffers.kotlin

Package-level declarations

Types

open class ArrayReadBuffer(buffer: ByteArray, offset: Int = 0, val limit: Int = buffer.size - offset) : ReadBuffer

class ArrayReadWriteBuffer(buffer: ByteArray, offset: Int = 0, val writeLimit: Int = -1, var writePosition: Int = offset) : ArrayReadBuffer, ReadWriteBuffer

Implements [ReadWriteBuffer] using ByteArray as backing buffer. Using array of bytes are usually faster than ByteBuffer.

BitWidth

@JvmInline

value class BitWidth(val value: Int)

Blob

open class Blob : Sized

Represent an array of bytes in the buffer.

ByteArrayOps

object ByteArrayOps

This implementation uses Little Endian order.

ByteWidth

@JvmInline

value class ByteWidth(val value: Int)

FlatBufferBuilder

class FlatBufferBuilder @JvmOverloads constructor(initialSize: Int = 1024, buffer: ReadWriteBuffer = ArrayReadWriteBuffer(initialSize))

Class that helps you build a FlatBuffer. See the section "Use in Kotlin" in the main FlatBuffers documentation.

FlexBuffersBuilder

@ExperimentalUnsignedTypes

class FlexBuffersBuilder(val buffer: ReadWriteBuffer, shareFlag: Int = SHARE_KEYS)

FlexBufferType

@JvmInline

value class FlexBufferType(val value: Int)

JSONParser

@ExperimentalUnsignedTypes

class JSONParser(var output: FlexBuffersBuilder = FlexBuffersBuilder(1024, SHARE_KEYS_AND_STRINGS))

JSONParser class is used to parse a JSON as FlexBuffers. Calling JSONParser.parse fiils output and returns a Reference ready to be used.

Key

data class Key(val buffer: ReadBuffer, val start: Int, val end: Int = buffer.findFirst(ZeroByte, start))

Represents a key element in the buffer. Keys are used to reference objects in a Map

Map

class Map : Sized, Map<Key, Reference>

A Map class that provide support to access Key-Value data from Flexbuffers.

Offset

@JvmInline

value class Offset<T>(val value: Int)

Represents a "pointer" to a pointer types (table, string, struct) within the buffer

OffsetArray

@JvmInline

value class OffsetArray<T>(val value: IntArray)

Represents an array of offsets. Used to avoid boxing offset types.

ReadBuffer

interface ReadBuffer

Represent a chunk of data, where FlexBuffers will be read from.

ReadWriteBuffer

interface ReadWriteBuffer : ReadBuffer

Interface to represent a read-write buffers. This interface will be used to access and write FlexBuffer messages.

Reference

class Reference

Represents an generic element in the buffer. It can be specialized into scalar types, using for example, Reference.toInt, or casted into Flexbuffer object types, like Reference.toMap or Reference.toBlob.

Sized

open class Sized

Represents any element that has a size property to it, like: Map, Vector and TypedVector.

StringOffsetArray

typealias StringOffsetArray = OffsetArray<String>

Struct

open class Struct

All structs in the generated code derive from this class, and add their own accessors.

Table

open class Table

All tables in the generated code derive from this class, and add their own accessors.

TypedVector

open class TypedVector(elementType: FlexBufferType, val buffer: ReadBuffer, val end: Int, val byteWidth: ByteWidth) : Vector

TypedVector represents an array of scalar elements of the same type in the buffer.

UnionOffset

typealias UnionOffset = Offset<Any>

UnionOffsetArray

typealias UnionOffsetArray = OffsetArray<Any>

Utf8

object Utf8

Vector

open class Vector : Sized, Collection<Reference>

Vector represents an array of elements in the buffer. The element can be of any type.

VectorOffset

@JvmInline

value class VectorOffset<T>(val value: Int)

Represents a "pointer" to a vector type with elements T

Properties

emptyBuffer

val emptyBuffer: ReadWriteBuffer

value

val <T> T.value: T

VERSION_2_0_8

const val VERSION_2_0_8: Int = 1

Functions

getRoot

fun getRoot(buffer: ReadBuffer): Reference

Reads a FlexBuffer message in ReadBuf and returns Reference to the root element.

minus

operator fun <T> Offset<T>.minus(other: Int): Offset<T>

operator fun <T> Int.minus(other: Offset<T>): Int

OffsetArray

inline fun <T> OffsetArray(size: Int, crossinline call: (Int) -> Offset<T>): OffsetArray<T>

setShort

expect inline fun ByteArray.setShort(index: Int, value: Short)

actual inline fun ByteArray.setShort(index: Int, value: Short)

sign

fun Double.sign(): Double

fun Float.sign(): Float

fun Int.sign(): Int

StringOffsetArray

inline fun StringOffsetArray(size: Int, crossinline call: (Int) -> Offset<String>): StringOffsetArray

toJson

fun Map.toJson(): String

fun Reference.toJson(): String

fun Vector.toJson(): String

fun Map.toJson(out: ReadWriteBuffer)

fun Reference.toJson(out: ReadWriteBuffer)

fun Vector.toJson(out: ReadWriteBuffer)

Returns a minified version of this FlexBuffer as a JSON.

toOffset

fun <T> Int.toOffset(): Offset<T>

UnionOffsetArray

inline fun UnionOffsetArray(size: Int, crossinline call: (Int) -> Offset<Any>): UnionOffsetArray