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

BufferedSourceJsonReader

class BufferedSourceJsonReader(source: BufferedSource) : JsonReader

A JsonWriter that reads json from an okio BufferedSource

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

To read from a Map, see also MapJsonReader

Constructors

BufferedSourceJsonReader

constructor(source: BufferedSource)

Types

Companion

object Companion

Functions

beginArray

open override fun beginArray(): JsonReader

Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.

beginObject

open override fun beginObject(): JsonReader

Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.

buffer

fun JsonReader.buffer(): MapJsonReader

buffers the next Object. Has to be called in BEGIN_OBJECT position. The returned MapJsonReader can use MapJsonReader.rewind to read fields multiple times

open override fun close()

endArray

open override fun endArray(): JsonReader

Consumes the next token from the JSON stream and asserts that it is the end of the current array.

endObject

open override fun endObject(): JsonReader

Consumes the next token from the JSON stream and asserts that it is the end of the current object.

getPath

open override fun getPath(): List<Any>

Returns the current path of the JSON being read, as a List. The elements can either be Strings (names) or Integers (array indices).

hasNext

open override fun hasNext(): Boolean

Returns true if the current array or object has another element.

nextBoolean

open override fun nextBoolean(): Boolean

Returns the Token.BOOLEAN value of the next token, consuming it.

nextDouble

open override fun nextDouble(): Double

Returns the Token.NUMBER value of the next token, consuming it.

nextInt

open override fun nextInt(): Int

Returns the Token.NUMBER value of the next token, consuming it.

nextLong

open override fun nextLong(): Long

Returns the Token.NUMBER value of the next token, consuming it.

nextName

open override fun nextName(): String

Returns the next token Token.NAME, and consumes it.

nextNull

open override fun nextNull(): Nothing?

Consumes the next token from the JSON stream and asserts that it is a literal null. Returns null.

nextNumber

open override fun nextNumber(): JsonNumber

Returns the Token.NUMBER value of the next token, consuming it.

nextString

open override fun nextString(): String?

Returns the Token.STRING value of the next token, consuming it.

parseResponse

@ApolloExperimental

fun <D : Operation.Data> JsonReader.parseResponse(operation: Operation<D>, requestUuid: Uuid? = null, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null): ApolloResponse<D>

peek

open override fun peek(): JsonReader.Token

Returns the type of the next token without consuming it.

readAny

fun JsonReader.readAny(): Any?

Reads the reader and maps numbers to the closest representation possible in that order:

readErrors

fun JsonReader.readErrors(): List<Error>

readTypename

fun JsonReader.readTypename(): String

rewind

open override fun rewind()

Reset the current object so that selectName start returning names again

selectName

open override fun selectName(names: List<String>): Int

An optimized way to retrieve the nextName when the candidates and their order is known. selectName maintains the current index in the list and saves having to string compare nextName to every candidate.

skipValue

open override fun skipValue()

Skips the next value recursively. If it is an object or array, all nested elements are skipped.

toApolloResponse

@ApolloExperimental

fun <D : Operation.Data> JsonReader.toApolloResponse(operation: Operation<D>, requestUuid: Uuid? = null, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null): ApolloResponse<D>

Parses the JsonReader into an ApolloResponse