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

CompressionEncoderBuilder

class CompressionEncoderBuilder : ConditionsHolderBuilder(source)

A builder for compression encoder configuration.

Report a problem

Properties

conditions

open override val conditions: <Error class: unknown class><ApplicationCall.(OutgoingContent) -> Boolean>

A list of conditions for this encoder

encoder

val encoder: ContentEncoder

instance

priority

var priority: Double

A priority for this encoder.

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.