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

ConditionsHolderBuilder

interface ConditionsHolderBuilder(source)

A builder for conditions.

Report a problem

Inheritors

CompressionConfig

CompressionEncoderBuilder

Properties

conditions

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

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

Functions

condition

fun ConditionsHolderBuilder.condition(predicate: ApplicationCall.(OutgoingContent) -> Boolean)

Appends a custom condition to the encoder or the Compression configuration. A predicate returns true when a response need to be compressed. If at least one condition is not met, a response isn't compressed.

excludeContentType

fun ConditionsHolderBuilder.excludeContentType(vararg mimeTypes: ContentType)

Appends a content type exclusion condition to the encoder or the Compression configuration.

matchContentType

fun ConditionsHolderBuilder.matchContentType(vararg mimeTypes: ContentType)

Appends a content type condition to the encoder or the Compression configuration.

minimumSize

fun ConditionsHolderBuilder.minimumSize(minSize: Long)

Appends a minimum size condition to the encoder or the Compression configuration.