commonMain.space.kscience.dataforge.io.EnvelopeBuilder.kt Maven / Gradle / Ivy

Go to download
package space.kscience.dataforge.io

import kotlinx.io.Sink
import space.kscience.dataforge.meta.*

public class EnvelopeBuilder : Envelope {
    private val metaBuilder = MutableMeta()

    override var data: Binary? = null
    override var meta: Meta
        get() = metaBuilder
        set(value) {
            metaBuilder.update(value)
        }

    public fun meta(block: MutableMeta.() -> Unit) {
        metaBuilder.apply(block)
    }

    /**
     * The general purpose of the envelope
     */
    public var type: String? by metaBuilder.string(key = Envelope.ENVELOPE_TYPE_KEY)
    public var dataType: String? by metaBuilder.string(key = Envelope.ENVELOPE_DATA_TYPE_KEY)

    /**
     * Data unique identifier to bypass identity checks
     */
    public var dataID: String? by metaBuilder.string(key = Envelope.ENVELOPE_DATA_ID_KEY)
    public var description: String? by metaBuilder.string(key = Envelope.ENVELOPE_DESCRIPTION_KEY)
    public var name: String? by metaBuilder.string(key = Envelope.ENVELOPE_NAME_KEY)

    /**
     * Construct a data binary from given builder
     */
    public inline fun data(block: Sink.() -> Unit) {
        data = ByteArray { block() }.asBinary()
    }

    public fun seal(): Envelope = SimpleEnvelope(metaBuilder.seal(), data)

}


/**
 * Build a static envelope using provided [builder]
 */
public inline fun Envelope(builder: EnvelopeBuilder.() -> Unit): Envelope = EnvelopeBuilder().apply(builder).seal()

//@ExperimentalContracts
//suspend fun EnvelopeBuilder.buildData(block: suspend Output.() -> Unit): Binary{
//    contract {
//        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
//    }
//    val scope = CoroutineScope(coroutineContext)
//}