commonMain.com.algolia.search.model.index.Scope.kt Maven / Gradle / Ivy

Go to download
package com.algolia.search.model.index

import com.algolia.search.endpoint.EndpointIndex
import com.algolia.search.model.internal.Raw
import com.algolia.search.serialize.internal.Key
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializable
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder

/**
 * Possible [Scope] to copy for a [EndpointIndex.copyIndex] operation.
 */
@Serializable(Scope.Companion::class)
public sealed class Scope(override val raw: String) : Raw {

    /**
     * Scope for [com.algolia.search.model.settings.Settings]
     */
    public object Settings : Scope(Key.Settings)

    /**
     * Scope for [com.algolia.search.model.synonym.Synonym]
     */
    public object Synonyms : Scope(Key.Synonyms)

    /**
     * Scope for [com.algolia.search.model.rule.Rule]
     */
    public object Rules : Scope(Key.Rules)

    public data class Other(override val raw: String) : Scope(raw)

    public companion object : KSerializer {

        private val serializer = String.serializer()

        override val descriptor: SerialDescriptor = serializer.descriptor

        override fun serialize(encoder: Encoder, value: Scope) {
            serializer.serialize(encoder, value.raw)
        }

        override fun deserialize(decoder: Decoder): Scope {
            return when (val string = serializer.deserialize(decoder)) {
                Key.Settings -> Settings
                Key.Synonyms -> Synonyms
                Key.Rules -> Rules
                else -> Other(string)
            }
        }
    }
}