commonMain.JsonStruct.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mirai-core-utils Show documentation

mirai-core utilities

The newest version!

/*
 * Copyright 2019-2021 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

package net.mamoe.mirai.utils

import kotlinx.serialization.DeserializationStrategy
import kotlinx.serialization.SerializationStrategy
import kotlinx.serialization.json.Json
import kotlin.reflect.typeOf

public interface JsonStruct

@PublishedApi
internal val defaultJson: Json = Json {
    isLenient = true
    ignoreUnknownKeys = true
}

public fun  String.loadAs(deserializer: DeserializationStrategy, json: Json = defaultJson): T {
    return json.decodeFromString(deserializer, this)
}

@OptIn(ExperimentalStdlibApi::class)
public inline fun  String.loadSafelyAs(
    deserializer: DeserializationStrategy,
    json: Json = defaultJson
): Either where T : JsonStruct {
    return try {
        Either(json.decodeFromString(deserializer, this))
    } catch (e: Throwable) {
        // typeOf is used in ktor and coroutines so Kotlin will absolutely provide ABI guarantee for it.
        Either(DeserializationFailure(typeOf(), this, e))
    }
}

public fun  T.toJsonString(serializer: SerializationStrategy, json: Json = defaultJson): String =
    json.encodeToString(serializer, this)