ServerConfiguration.ResponseCompressionConfiguration

Topics

Instance Properties

• var allowRequestOverrides: Bool
  Allow routes and requests to explicitly override compression.
• var initialByteBufferCapacity: Int
  The initial buffer capacity to use when instantiating the compressor.

Type Properties

• static let defaultInitialByteBufferCapacity: Int
  The default initial byte buffer capacity to use for the compressor if none is specified.
• static var disabled: `Self`
  Disables compression for all content types unless a route overrides the preference. This is the default.
• static var enabled: `Self`
  Enables compression by default, disallowing already compressed types such as images or video, unless a route overrides the preference.
• static var enabledForCompressibleTypes: `Self`
  Disables compression by default, but allows easily compressible types such as text, unless a route overrides the preference.
• static var forceDisabled: `Self`
  Disables compression unconditionally.

Type Methods

• static func disabled(initialByteBufferCapacity: Int, allowedTypes: HTTPMediaTypeSet, allowRequestOverrides: Bool) -> ServerConfiguration.ResponseCompressionConfiguration
  Disables compression by default, but offers options to allow it for the specified types.
• static func enabled(initialByteBufferCapacity: Int, disallowedTypes: HTTPMediaTypeSet, allowRequestOverrides: Bool) -> ServerConfiguration.ResponseCompressionConfiguration
  Enables compression by default, but offers options to disallow it for the specified types.