commonMain.io.ktor.http.Headers.kt Maven / Gradle / Ivy
/*
* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/
package io.ktor.http
import io.ktor.util.*
/**
* Represents HTTP headers as a map from case-insensitive names to collection of [String] values
*/
public interface Headers : StringValues {
public companion object {
/**
* Empty [Headers] instance
*/
@Suppress("DEPRECATION_ERROR")
public val Empty: Headers = EmptyHeaders
/**
* Builds a [Headers] instance with the given [builder] function
* @param builder specifies a function to build a map
*/
public inline fun build(builder: HeadersBuilder.() -> Unit): Headers = HeadersBuilder().apply(builder).build()
}
}
@Suppress("KDocMissingDocumentation")
public class HeadersBuilder(size: Int = 8) : StringValuesBuilderImpl(true, size) {
override fun build(): Headers {
return HeadersImpl(values)
}
override fun validateName(name: String) {
super.validateName(name)
HttpHeaders.checkHeaderName(name)
}
override fun validateValue(value: String) {
super.validateValue(value)
HttpHeaders.checkHeaderValue(value)
}
}
@Suppress("KDocMissingDocumentation")
@Deprecated(
"Empty headers is internal",
replaceWith = ReplaceWith("Headers.Empty"),
level = DeprecationLevel.ERROR
)
public object EmptyHeaders : Headers {
override val caseInsensitiveName: Boolean get() = true
override fun getAll(name: String): List? = null
override fun names(): Set = emptySet()
override fun entries(): Set>> = emptySet()
override fun isEmpty(): Boolean = true
override fun toString(): String = "Headers ${entries()}"
}
/**
* Returns empty headers
*/
public fun headersOf(): Headers = Headers.Empty
/**
* Returns [Headers] instance containing only one header with the specified [name] and [value]
*/
public fun headersOf(name: String, value: String): Headers = HeadersSingleImpl(name, listOf(value))
/**
* Returns [Headers] instance containing only one header with the specified [name] and [values]
*/
public fun headersOf(name: String, values: List): Headers = HeadersSingleImpl(name, values)
/**
* Returns [Headers] instance from [pairs]
*/
public fun headersOf(vararg pairs: Pair>): Headers = HeadersImpl(pairs.asList().toMap())
/**
* Builds a [Headers] instance with the given [builder] function
* @param builder specifies a function to build a map
*/
public fun headers(builder: HeadersBuilder.() -> Unit): Headers = Headers.build(builder)
@Suppress("KDocMissingDocumentation")
public class HeadersImpl(
values: Map> = emptyMap()
) : Headers, StringValuesImpl(true, values) {
override fun toString(): String = "Headers ${entries()}"
}
@Suppress("KDocMissingDocumentation")
public class HeadersSingleImpl(
name: String,
values: List
) : Headers, StringValuesSingleImpl(true, name, values) {
override fun toString(): String = "Headers ${entries()}"
}