ktor-client-core/io.ktor.client.statement

Package-level declarations

Types

DefaultHttpResponse

class DefaultHttpResponse(val call: HttpClientCall, responseData: HttpResponseData) : HttpResponse

HttpReceivePipeline

class HttpReceivePipeline(val developmentMode: Boolean = true) : Pipeline<HttpResponse, Unit>

HttpClient Pipeline used for receiving HttpResponse without any processing.

abstract class HttpResponse : HttpMessage, CoroutineScope

An HttpClient's response, a second part of HttpClientCall.

HttpResponseContainer

data class HttpResponseContainer(val expectedType: TypeInfo, val response: Any)

Class representing a typed response with an attached expectedType.

HttpResponsePipeline

class HttpResponsePipeline(val developmentMode: Boolean = true) : Pipeline<HttpResponseContainer, HttpClientCall>

HttpClient Pipeline used for executing HttpResponse.

class HttpStatement(builder: HttpRequestBuilder, client: HttpClient)

Represents a prepared HTTP request statement for HttpClient.

Properties

val HttpResponse.~~content~~: ByteReadChannel

Provides a raw ByteReadChannel to the response content as it was read from the network. This content can be still compressed or encoded.

val HttpResponse.request: HttpRequest

Gets HttpRequest associated with this response.

Functions

suspend fun HttpResponse.bodyAsBytes(): ByteArray

Reads the response body as a byte array. Note that all plugins will be applied to the response body, which may be decompressed or decoded.

suspend fun HttpResponse.bodyAsChannel(): ByteReadChannel

Reads the HttpResponse.rawContent as a ByteReadChannel.

suspend fun HttpResponse.bodyAsText(fallbackCharset: Charset = Charsets.UTF_8): String

Reads the HttpResponse.rawContent as a String. You can pass an optional charset to specify a charset in the case no one is specified as part of the Content-Type response. If no charset specified either as parameter or as part of the response, io.ktor.client.plugins.HttpPlainText settings will be used.

discardRemaining

suspend fun HttpResponse.discardRemaining()

Efficiently discards the remaining bytes of HttpResponse.rawContent.

suspend fun HttpResponse.~~readBytes~~(): ByteArray

Reads the raw payload of the HTTP response as a byte array.

suspend fun HttpResponse.readBytes(count: Int): ByteArray

Reads exactly count bytes of the HttpResponse.rawContent.

suspend fun HttpResponse.readRawBytes(): ByteArray

Reads the raw payload of the HTTP response as a byte array.