ktor-client-encoding/io.ktor.client.plugins.compression

Package-level declarations

Types

ContentEncodingConfig

class ContentEncodingConfig

A configuration for the ContentEncoding plugin.

UnsupportedContentEncodingException

class UnsupportedContentEncodingException(encoding: String) : IllegalStateException

Properties

appliedDecoders

val HttpResponse.appliedDecoders: List<String>

List of ContentEncoder names that were used to decode response body.

ContentEncoding

val ContentEncoding: ClientPlugin<ContentEncodingConfig>

A plugin that allows you to enable specified compression algorithms (such as gzip and deflate) and configure their settings. This plugin serves two primary purposes:

Functions

compress

fun HttpRequestBuilder.compress(vararg contentEncoderName: String)

Compresses request body using ContentEncoding plugin.

fun HttpRequestBuilder.compress(contentEncoderNames: List<String>)

Compress request body using ContentEncoding plugin.

ContentEncoding

fun HttpClientConfig<*>.ContentEncoding(mode: ContentEncodingConfig.Mode = ContentEncodingConfig.Mode.DecompressResponse, block: ContentEncodingConfig.() -> Unit = { gzip() deflate() identity() })

Installs or configures the ContentEncoding plugin.