io.ktor.client.statement

DefaultHttpResponse

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

HttpReceivePipeline

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

HttpClient Pipeline used for receiving HttpResponse without any processing.

HttpResponse

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 = false) : Pipeline<HttpResponseContainer, HttpClientCall>

HttpClient Pipeline used for executing HttpResponse.

HttpStatement

class HttpStatement(builder: HttpRequestBuilder, client: HttpClient)

Prepared statement for a HTTP client request. This statement doesn't perform any network requests until execute method call. HttpStatement is safe to execute multiple times.

bodyAsChannel

suspend fun HttpResponse.bodyAsChannel(): ByteReadChannel

Reads the HttpResponse.content as a ByteReadChannel.

bodyAsText

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

Reads the HttpResponse.content 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.content.

readBytes

suspend fun HttpResponse.readBytes(): ByteArray

Reads the whole HttpResponse.content if Content-Length is specified. Otherwise, it just reads one byte.

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

Reads exactly count bytes of the HttpResponse.content.

readText

suspend fun HttpResponse.~~readText~~(fallbackCharset: Charset? = null): String

Read the HttpResponse.content 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.

receive

inline suspend fun <T> HttpStatement.~~receive~~(): T

Executes this statement and run HttpClient.responsePipeline with the response and expected type T.

inline suspend fun <T, R> HttpStatement.~~receive~~(crossinline block: suspend (response: T) -> R): R

Executes this statement and run the block with a HttpClient.responsePipeline execution result.

request

val HttpResponse.request: HttpRequest

Gets HttpRequest associated with this response.

Package-level declarations

Types

Functions

Properties