commonMain.io.realm.kotlin.internal.interop.RealmValue.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cinterop Show documentation

Wrapper for interacting with Realm Kotlin native code. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.13.0' instead.

The newest version!

/*
 * Copyright 2022 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.realm.kotlin.internal.interop

/**
 * Representation of a C-API `realm_value_t` struct.
 */
expect class RealmValueT

/**
 *  Representation of a list of contiguous C-API `realm_value_t` structs that can be passed as a
 *  pointer to the C-API.
 */
expect class RealmValueList {
    val size: Int

    /**
     * Update the element at the index with a given value.
     */
    operator fun set(index: Int, value: RealmValue)
}

/**
 * Inline class used for handling C-API `realm_value_t` structs. It behaves exactly like the struct.
 */
expect value class RealmValue(val value: RealmValueT) {

    // TODO should we consider scoping these functions to an allocator?
    inline fun getType(): ValueType

    inline fun getLong(): Long
    inline fun getBoolean(): Boolean
    inline fun getString(): String
    inline fun getByteArray(): ByteArray
    inline fun getTimestamp(): Timestamp
    inline fun getFloat(): Float
    inline fun getDouble(): Double
    inline fun getObjectIdBytes(): ByteArray
    inline fun getUUIDBytes(): ByteArray
    inline fun getDecimal128Array(): ULongArray
    inline fun getLink(): Link
    inline fun isNull(): Boolean
}

/**
 * Inline class used for handling C-API `realm_query_arg_t` structs used when building queries.
 */
expect class RealmQueryArgumentList
sealed interface RealmQueryArgument
class RealmQuerySingleArgument(val argument: RealmValue) : RealmQueryArgument
class RealmQueryListArgument(val arguments: RealmValueList) : RealmQueryArgument