flatbuffers-kotlin/com.google.flatbuffers.kotlin/Reference

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.

Properties

isBlob

val isBlob: Boolean

Checks whether the element type is a blob

isBoolean

val isBoolean: Boolean

Checks whether the element is boolean type

isFloat

val isFloat: Boolean

Checks whether the element type is float

isInt

val isInt: Boolean

Checks whether the element type is signed integer

isIntOrUInt

val isIntOrUInt: Boolean

Checks whether the element type is signed or unsigned integers

isKey

val isKey: Boolean

Checks whether the element type is key

isMap

val isMap: Boolean

Checks whether the element type is a map

isNull

val isNull: Boolean

Checks whether the element is null type

isNumeric

val isNumeric: Boolean

Checks whether the element type is numeric (signed/unsigned integers and floats)

isString

val isString: Boolean

Checks whether the element type is string

isTypedVector

val isTypedVector: Boolean

Checks whether the element type is typed vector

isUInt

val isUInt: Boolean

Checks whether the element type is signed integer

isVector

val isVector: Boolean

Checks whether the element type is vector or a map. TypedVector are considered different types and will return false.

type

val type: FlexBufferType

Functions

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun get(index: Int): Reference

Assumes Reference as a Vector and returns a Reference at index index.

operator fun get(key: String): Reference

Assumes Reference as a Map and returns a Reference for the value at key key.

hashCode

open override fun hashCode(): Int

toBlob

fun toBlob(): Blob

Returns element as a Blob

toBoolean

fun toBoolean(): Boolean

Returns element as a Boolean. If element type is not boolean, it will be casted to integer and compared against 0

toByte

fun toByte(): Byte

Returns element as Byte. For vector types, it will return size of the vector. For String type, it will be parsed as integer. Unsigned elements will become signed (with possible overflow). Float elements will be casted to Byte.

toByteArray

fun toByteArray(): ByteArray

Returns element as a ByteArray, converting scalar types when possible.

toDouble

fun toDouble(): Double

Returns element as Double. For vector types, it will return size of the vector For String type, it will type to be parsed as Double

toDoubleArray

fun toDoubleArray(): DoubleArray

Returns element as a DoubleArray, converting scalar types when possible.

toFloat

fun toFloat(): Float

Returns element as Float. For vector types, it will return size of the vector For String type, it will type to be parsed as Float Float elements will be casted to integer

toFloatArray

fun toFloatArray(): FloatArray

Returns element as a FloatArray, converting scalar types when possible.

toInt

fun toInt(): Int

Returns element as Int. For vector types, it will return size of the vector. For String type, it will type to be parsed as integer. Unsigned elements will become signed (with possible overflow). Float elements will be casted to Int

toIntArray

fun toIntArray(): IntArray

Returns element as a IntArray, converting scalar types when possible.

toJson

fun Reference.toJson(): String

fun Reference.toJson(out: ReadWriteBuffer)

Returns a minified version of this FlexBuffer as a JSON.

toKey

fun toKey(): Key

Returns element as Key or invalid key.

toLong

fun toLong(): Long

Returns element as Long. For vector types, it will return size of the vector For String type, it will type to be parsed as integer Unsigned elements will become negative Float elements will be casted to integer

toLongArray

fun toLongArray(): LongArray

Returns element as a LongArray, converting scalar types when possible.

toMap

fun toMap(): Map

Returns element as a Map.

toShort

fun toShort(): Short

Returns element as Short. For vector types, it will return size of the vector. For String type, it will type to be parsed as integer. Unsigned elements will become signed (with possible overflow). Float elements will be casted to Short

toShortArray

fun toShortArray(): ShortArray

Returns element as a ByteArray, converting scalar types when possible.

toString

open override fun toString(): String

Returns element as a String

toUByte

fun toUByte(): UByte

Returns element as UByte. For vector types, it will return size of the vector. For String type, it will type to be parsed as integer. Negative elements will become unsigned counterpart. Float elements will be casted to UByte

toUByteArray

fun toUByteArray(): UByteArray

Returns element as a UByteArray, converting scalar types when possible.

toUInt

fun toUInt(): UInt

Returns element as UInt. For vector types, it will return size of the vector. For String type, it will type to be parsed as integer. Negative elements will become unsigned counterpart. Float elements will be casted to UInt

toUIntArray

fun toUIntArray(): UIntArray

Returns element as a UIntArray, converting scalar types when possible.

toULong

fun toULong(): ULong

Returns element as ULong integer. For vector types, it will return size of the vector For String type, it will type to be parsed as integer Negative elements will become unsigned counterpart. Float elements will be casted to integer

toULongArray

fun toULongArray(): ULongArray

Returns element as a ULongArray, converting scalar types when possible.

toUShort

fun toUShort(): UShort

Returns element as UShort. For vector types, it will return size of the vector. For String type, it will type to be parsed as integer. Negative elements will become unsigned counterpart. Float elements will be casted to UShort

toUShortArray

fun toUShortArray(): UShortArray

Returns element as a UIntArray, converting scalar types when possible.

toVector

fun toVector(): Vector

Returns element as a Vector