ktor-client-core/io.ktor.client.call/HttpClientCall

HttpClientCall

open class HttpClientCall(val client: HttpClient) : CoroutineScope

A pair of a request and response for a specific HttpClient.

Constructors

constructor(client: HttpClient, requestData: HttpRequestData, responseData: HttpResponseData)

constructor(client: HttpClient)

Types

object Companion

Properties

val attributes: Attributes

Typed Attributes associated to this call serving as a lightweight container.

val client: HttpClient

the client that executed the call.

coroutineContext

open override val coroutineContext: CoroutineContext

lateinit var request: HttpRequest

The request sent by the client.

lateinit var response: HttpResponse

The response sent by the server.

Functions

suspend fun body(info: TypeInfo): Any

Tries to receive the payload of the response as a specific expected type provided in info. Returns response if info corresponds to HttpResponse.

inline suspend fun <T> HttpClientCall.body(): T

Tries to receive the payload of the response as a specific type T.

suspend fun bodyNullable(info: TypeInfo): Any?

Tries to receive the payload of the response as a specific expected type provided in info. Returns response if info corresponds to HttpResponse.

suspend fun HttpClientCall.save(): HttpClientCall

Saves the entire content of this HttpClientCall to memory and returns a new HttpClientCall with the content cached in memory. This can be particularly useful for caching, debugging, or processing responses without relying on the original network stream.

open override fun toString(): String

fun HttpClientCall.wrap(content: ByteReadChannel, headers: Headers): HttpClientCall

Wrap existing HttpClientCall with new response content and headers.

wrapWithContent

fun HttpClientCall.wrapWithContent(content: ByteReadChannel): HttpClientCall

Wrap existing HttpClientCall with new content.

fun HttpClientCall.wrapWithContent(block: () -> ByteReadChannel): HttpClientCall

Wrap existing HttpClientCall with new content.