commonMain.com.ctrip.flight.mmkv.MMKV_KMP.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmkv-kotlin Show documentation
MMKV for Kotlin Multiplatform
The newest version!
/*
 * Copyright (C) 2022 Ctrip.com.
 *
 * 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 com.ctrip.flight.mmkv

/**
 * MMKV common source set expect class
 * @author yaqiao
 */

interface MMKV_KMP {

    /**
     * Write value
     */

    operator fun set(key: String, value: String): Boolean

    operator fun set(key: String, value: Boolean): Boolean

    operator fun set(key: String, value: Int): Boolean

    operator fun set(key: String, value: Long): Boolean

    operator fun set(key: String, value: Float): Boolean

    operator fun set(key: String, value: Double): Boolean

    operator fun set(key: String, value: ByteArray): Boolean

    operator fun set(key: String, value: UInt): Boolean

    operator fun set(key: String, value: ULong): Boolean

    operator fun set(key: String, value: Set?): Boolean

    /**
     * Read value
     */

    fun takeString(key: String, default: String = ""): String

    fun takeBoolean(key: String, default: Boolean = false): Boolean

    fun takeInt(key: String, default: Int = 0): Int

    fun takeLong(key: String, default: Long = 0): Long

    fun takeFloat(key: String, default: Float = 0f): Float

    fun takeDouble(key: String, default: Double = 0.0): Double

    fun takeByteArray(key: String, default: ByteArray? = null): ByteArray?

    fun takeUInt(key: String, default: UInt = 0u): UInt

    fun takeULong(key: String, default: ULong = 0u): ULong

    fun takeStringSet(key: String, default: Set? = null): Set?

    /**
     * Remove value
     */

    fun removeValueForKey(key: String)

    fun removeValuesForKeys(keys: List)

    /**
     * Size
     */

    val actualSize: Long

    val count: Long

    val totalSize: Long

    /**
     * Clear
     */

    fun clearMemoryCache()

    fun clearAll()

    /**
     * Other
     */

    fun close()

    fun allKeys(): List

    fun containsKey(key: String): Boolean

    fun checkReSetCryptKey(key: String?)

    fun mmapID(): String

    fun async()

    fun sync()

    fun trim()
}