apollo-api/com.apollographql.apollo3.api.json/BufferedSinkJsonWriter

BufferedSinkJsonWriter

class BufferedSinkJsonWriter @JvmOverloads constructor(sink: BufferedSink, indent: String? = null) : JsonWriter

A JsonWriter that writes json to an okio BufferedSink

The base implementation was taken from Moshi and ported to Kotlin multiplatform with some tweaks to make it better suited for GraphQL (see JsonWriter and path).

To writer to a Map, see also MapJsonWriter

Parameters

indent

: A string containing a full set of spaces for a single level of indentation, or null for no pretty printing.

Constructors

BufferedSinkJsonWriter

@JvmOverloads

fun BufferedSinkJsonWriter(sink: BufferedSink, indent: String? = null)

Types

Companion

object Companion

Functions

beginArray

open override fun beginArray(): JsonWriter

Begins encoding a new array. Each call to this method must be paired with a call to endArray.

beginObject

open override fun beginObject(): JsonWriter

Begins encoding a new object. Each call to this method must be paired with a call to endObject.

open override fun close()

Flushes and closes this writer and the underlying okio.Sink.

endArray

open override fun endArray(): JsonWriter

Ends encoding the current array.

endObject

open override fun endObject(): JsonWriter

Ends encoding the current object.

flush

open override fun flush()

Ensures all buffered data is written to the underlying okio.Sink and flushes that writer.

jsonValue

fun jsonValue(value: String): JsonWriter

Writes the given value as raw json without escaping. It is the caller responsibility to make sure value is a valid json string

name

open override fun name(name: String): JsonWriter

Encodes the property name.

nullValue

open override fun nullValue(): JsonWriter

Encodes null.

value

open override fun value(value: Upload): BufferedSinkJsonWriter

Encodes a Upload.

open override fun value(value: JsonNumber): JsonWriter

Encodes number value.

open override fun value(value: Boolean): JsonWriter

Encodes boolean value.

open override fun value(value: Double): JsonWriter

Encodes a finite double value.

open override fun value(value: Int): JsonWriter

Encodes int value.

open override fun value(value: Long): JsonWriter

Encodes long value.

open override fun value(value: String): JsonWriter

Encodes the literal string value, or null to encode a null literal.

Properties

path

open override val path: String

Returns a JsonPath to the current location in the JSON value.