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

Returns the length of the value in bytes.

val encoding: SqliteTextEncoding.ValueEncoding

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

val isFromBind: Boolean

Whether the value originated from a bound parameter.

val numericType: SqliteDataType

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

val subtype: UInt

Returns the subtype of the value.

val type: SqliteDataType

Data type of the value.

Functions

fun duplicate(): DuplicatedValue

Duplicates the value, returning a DuplicatedValue.

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

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

fun ProtectedValue.getAsBoolean(): Boolean

Returns the value as a Boolean, using SQLite's own convention for booleans, 1 for true and 0 for false, since SQLite has no dedicated boolean storage class.

fun getAsBuffer(): ReadableBuffer?

Returns the value as a ReadableBuffer.

fun getAsByteArray(): ByteArray?

Returns the value as a ByteArray.

fun getAsDouble(): Double

Returns the value as a Double.

fun getAsInt(): Int

Returns the value as an Int.

fun getAsLong(): Long

Returns the value as a Long.

fun getAsString(): String?

Returns the value as a String.