ktor-server-compression/io.ktor.server.plugins.compression/CompressionConfig

CompressionConfig

class CompressionConfig : ConditionsHolderBuilder

A configuration for the Compression plugin.

Constructors

CompressionConfig

fun CompressionConfig()

Functions

~~fun~~ ~~build~~(): CompressionOptions

Builds CompressionOptions

Appends the default configuration with the gzip, deflate, and identity encoders.

fun encoder(name: String, encoder: CompressionEncoder, block: CompressionEncoderBuilder.() -> Unit = {})

Appends an encoder with the specified name and block configuration.

Properties

open override val conditions: MutableList<ApplicationCall.(OutgoingContent) -> Boolean>

Preconditions applied to every response object to check if it should be compressed.

val encoders: MutableMap<String, CompressionEncoderBuilder>

Provides access to a map of encoders.

Extensions

fun CompressionConfig.deflate(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the deflate encoder with the block configuration and the 0.9 priority.

fun CompressionConfig.gzip(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the gzip encoder with the block configuration.

fun CompressionConfig.identity(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the identity encoder with the block configuration.