/* * Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. */ package kotlinx.serialization.json.io import kotlinx.serialization.* import kotlinx.serialization.json.DecodeSequenceMode import kotlinx.serialization.json.Json import kotlinx.serialization.json.internal.* import kotlinx.serialization.json.io.internal.JsonToIoStreamWriter import kotlinx.serialization.json.internal.decodeToSequenceByReader import kotlinx.serialization.json.io.internal.IoSerialReader import kotlinx.io.* /** * Serializes the [value] with [serializer] into a [sink] using JSON format and UTF-8 encoding. * * @throws [SerializationException] if the given value cannot be serialized to JSON. * @throws [kotlinx.io.IOException] If an I/O error occurs and sink can't be written to. */ @ExperimentalSerializationApi public fun Json.encodeToSink( serializer: SerializationStrategy, value: T, sink: Sink ) { val writer = JsonToIoStreamWriter(sink) try { encodeByWriter(this, writer, serializer, value) } finally { writer.release() } } /** * Serializes given [value] to a [sink] using UTF-8 encoding and serializer retrieved from the reified type parameter. * * @throws [SerializationException] if the given value cannot be serialized to JSON. * @throws [kotlinx.io.IOException] If an I/O error occurs and sink can't be written to. */ @ExperimentalSerializationApi public inline fun Json.encodeToSink( value: T, sink: Sink ): Unit = encodeToSink(serializersModule.serializer(), value, sink) /** * Deserializes JSON from [source] using UTF-8 encoding to a value of type [T] using [deserializer]. * * Note that this functions expects that exactly one object would be present in the source * and throws an exception if there are any dangling bytes after an object. * * @throws [SerializationException] if the given JSON input cannot be deserialized to the value of type [T]. * @throws [kotlinx.io.IOException] If an I/O error occurs and source can't be read from. */ @ExperimentalSerializationApi public fun Json.decodeFromSource( deserializer: DeserializationStrategy, source: Source ): T { return decodeByReader(this, deserializer, IoSerialReader(source)) } /** * Deserializes the contents of given [source] to the value of type [T] using UTF-8 encoding and * deserializer retrieved from the reified type parameter. * * Note that this functions expects that exactly one object would be present in the stream * and throws an exception if there are any dangling bytes after an object. * * @throws [SerializationException] if the given JSON input cannot be deserialized to the value of type [T]. * @throws [kotlinx.io.IOException] If an I/O error occurs and source can't be read from. */ @ExperimentalSerializationApi public inline fun Json.decodeFromSource(source: Source): T = decodeFromSource(serializersModule.serializer(), source) /** * Transforms the given [source] into lazily deserialized sequence of elements of type [T] using UTF-8 encoding and [deserializer]. * Unlike [decodeFromSource], [source] is allowed to have more than one element, separated as [format] declares. * * Elements must all be of type [T]. * Elements are parsed lazily when resulting [Sequence] is evaluated. * Resulting sequence is tied to the stream and can be evaluated only once. * * **Resource caution:** this method neither closes the [source] when the parsing is finished nor provides a method to close it manually. * It is a caller responsibility to hold a reference to a source and close it. Moreover, because source is parsed lazily, * closing it before returned sequence is evaluated completely will result in [Exception] from decoder. * * @throws [SerializationException] if the given JSON input cannot be deserialized to the value of type [T]. * @throws [kotlinx.io.IOException] If an I/O error occurs and source can't be read from. */ @ExperimentalSerializationApi public fun Json.decodeSourceToSequence( source: Source, deserializer: DeserializationStrategy, format: DecodeSequenceMode = DecodeSequenceMode.AUTO_DETECT ): Sequence { return decodeToSequenceByReader(this, IoSerialReader(source), deserializer, format) } /** * Transforms the given [source] into lazily deserialized sequence of elements of type [T] using UTF-8 encoding and deserializer retrieved from the reified type parameter. * Unlike [decodeSourceToSequence], [source] is allowed to have more than one element, separated as [format] declares. * * Elements must all be of type [T]. * Elements are parsed lazily when resulting [Sequence] is evaluated. * Resulting sequence is tied to the stream and constrained to be evaluated only once. * * **Resource caution:** this method does not close [source] when the parsing is finished neither provides method to close it manually. * It is a caller responsibility to hold a reference to a source and close it. Moreover, because source is parsed lazily, * closing it before returned sequence is evaluated fully would result in [Exception] from decoder. * * @throws [SerializationException] if the given JSON input cannot be deserialized to the value of type [T]. * @throws [kotlinx.io.IOException] If an I/O error occurs and source can't be read from. */ @ExperimentalSerializationApi public inline fun Json.decodeSourceToSequence( source: Source, format: DecodeSequenceMode = DecodeSequenceMode.AUTO_DETECT ): Sequence = decodeSourceToSequence(source, serializersModule.serializer(), format)