Ksqlite Kotlin API/ksqlite.kapi.value/ProtectedValue

ProtectedValue

open class ProtectedValue : Value(source)

Represents a protected Value.

SQLite may perform an implicit type conversion to match the requested value type. If conversion is not feasible then null is returned.

Inheritors

DuplicatedValue

Properties

bytes

val bytes: Int

Returns the length of the value in bytes.

encoding

val encoding: SqliteTextEncoding.ValueEncoding

Returns the current text encoding of the value, assuming that type returns ksqlite.types.SqliteDataType.TEXT.

isFromBind

val isFromBind: Boolean

Whether the value originated from a bound parameter.

numericType

val numericType: SqliteDataType

Returns the type of the value after a numeric conversion as been done. The conversion is only made if the value can be converted.

subtype

val subtype: UInt

Returns the subtype of the value.

type

val type: SqliteDataType

Data type of the value.

Functions

duplicate

fun duplicate(): DuplicatedValue

Duplicates the value, returning a DuplicatedValue.

getAs

inline fun <Data : Any> getAs(type: String? = null): Data?

Returns the value as Data or null if no data is associated with type.

getAsBuffer

fun getAsBuffer(): ReadableBuffer?

Returns the value as a ksqlite.capi.memory.ReadableBuffer.

getAsByteArray

fun getAsByteArray(): ByteArray?

Returns the value as ByteArray.

getAsDouble

fun getAsDouble(): Double

Returns the value as Double.

getAsInt

fun getAsInt(): Int

Returns the value as Int.

getAsLong

fun getAsLong(): Long

Returns the value as Long.

getAsString

fun getAsString(): String?

Returns the value as String.