ktor-http

alltypes

object AuthScheme

const val Basic: String
const val Digest: String
const val Negotiate: String
const val OAuth: String
fun getBasic(): String
fun getDigest(): String
fun getNegotiate(): String

class BadContentTypeFormatException : Exception

BadContentTypeFormatException(value: String)

typealias ByteArrayContent = ByteArrayContent
class ByteArrayContent : ByteArrayContent

ByteArrayContent(bytes: ByteArray, contentType: ContentType? = null, status: HttpStatusCode? = null)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType?
val status: HttpStatusCode?

sealed class CacheControl

class MaxAge : CacheControl

MaxAge(maxAgeSeconds: Int, proxyMaxAgeSeconds: Int? = null, mustRevalidate: Boolean = false, proxyRevalidate: Boolean = false, visibility: Visibility? = null)
fun equals(other: Any?): Boolean
fun hashCode(): Int
val maxAgeSeconds: Int
val mustRevalidate: Boolean
val proxyMaxAgeSeconds: Int?
val proxyRevalidate: Boolean
fun toString(): String

class NoCache : CacheControl

NoCache(visibility: Visibility?)
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

class NoStore : CacheControl

NoStore(visibility: Visibility?)
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

enum class Visibility

Private
Public

val visibility: Visibility?

data class CachingOptions

CachingOptions(cacheControl: CacheControl? = null, expires: GMTDate? = null)
val cacheControl: CacheControl?
val expires: GMTDate?

class ChannelWriterContent : WriteChannelContent

ChannelWriterContent(body: suspend ByteWriteChannel.() -> Unit, contentType: ContentType?, status: HttpStatusCode? = null)
val contentType: ContentType?
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

class ContentDisposition : HeaderValueWithParameters

ContentDisposition(disposition: String, parameters: List<HeaderValueParam> = emptyList())
val Attachment: ContentDisposition
val File: ContentDisposition
val Inline: ContentDisposition
val Mixed: ContentDisposition
object Parameters

const val CreationDate: String
const val FileName: String
const val FileNameAsterisk: String
const val Handling: String
const val ModificationDate: String
const val Name: String
const val ReadDate: String
const val Size: String

val disposition: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
val name: String?
fun parse(value: String): ContentDisposition
fun withParameter(key: String, value: String): ContentDisposition
fun withParameters(newParameters: List<HeaderValueParam>): ContentDisposition

sealed class ContentRange

data class Bounded : ContentRange

Bounded(from: Long, to: Long)
val from: Long
val to: Long
fun toString(): String

data class Suffix : ContentRange

Suffix(lastCount: Long)
val lastCount: Long
fun toString(): String

data class TailFrom : ContentRange

TailFrom(from: Long)
val from: Long
fun toString(): String

class ContentType : HeaderValueWithParameters

ContentType(contentType: String, contentSubtype: String, parameters: List<HeaderValueParam> = emptyList())
val Any: ContentType
object Application

val Any: ContentType
val Atom: ContentType
val Cbor: ContentType
val FontWoff: ContentType
val FormUrlEncoded: ContentType
val GZip: ContentType
val HalJson: ContentType
val JavaScript: ContentType
val Json: ContentType
val OctetStream: ContentType
val Pdf: ContentType
val ProblemJson: ContentType
val ProblemXml: ContentType
val ProtoBuf: ContentType
val Rss: ContentType
val Wasm: ContentType
val Xml: ContentType
val Xml_Dtd: ContentType
val Zip: ContentType

object Audio

val Any: ContentType
val MP4: ContentType
val MPEG: ContentType
val OGG: ContentType

object Image

val Any: ContentType
val GIF: ContentType
val JPEG: ContentType
val PNG: ContentType
val SVG: ContentType
val XIcon: ContentType

object Message

val Any: ContentType
val Http: ContentType

object MultiPart

val Alternative: ContentType
val Any: ContentType
val ByteRanges: ContentType
val Encrypted: ContentType
val FormData: ContentType
val Mixed: ContentType
val Related: ContentType
val Signed: ContentType

object Text

val Any: ContentType
val CSS: ContentType
val CSV: ContentType
val EventStream: ContentType
val Html: ContentType
val JavaScript: ContentType
val Plain: ContentType
val VCard: ContentType
val Xml: ContentType

object Video

val Any: ContentType
val MP4: ContentType
val MPEG: ContentType
val OGG: ContentType
val QuickTime: ContentType

val contentSubtype: String
val contentType: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun match(pattern: ContentType): Boolean
fun match(pattern: String): Boolean
fun parse(value: String): ContentType
fun withParameter(name: String, value: String): ContentType
fun withoutParameters(): ContentType

interface ContentTypeMatcher

abstract fun contains(contentType: ContentType): Boolean

data class Cookie

Cookie(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap())
val domain: String?
val encoding: CookieEncoding
val expires: GMTDate?
val extensions: Map<String, String?>
fun getMaxAge(): Int
val httpOnly: Boolean
val maxAge: Int
val name: String
val path: String?
val secure: Boolean
val value: String

enum class CookieEncoding

BASE64_ENCODING
DQUOTES
RAW
URI_ENCODING

object EmptyHeaders : Headers

val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>
fun toString(): String

object EmptyParameters : Parameters

val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun equals(other: Any?): Boolean
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>
fun toString(): String

data class EntityTagVersion : Version

EntityTagVersion(etag: String)
EntityTagVersion(etag: String, weak: Boolean)
val STAR: EntityTagVersion
fun appendHeadersTo(builder: HeadersBuilder): Unit
fun check(requestHeaders: Headers): VersionCheckResult
val etag: String
fun match(other: EntityTagVersion): Boolean
fun match(givenMatchEtags: List<EntityTagVersion>): VersionCheckResult
fun noneMatch(givenNoneMatchEtags: List<EntityTagVersion>): VersionCheckResult
fun parse(headerValue: String): List<EntityTagVersion>
fun parseSingle(value: String): EntityTagVersion
val weak: Boolean

data class HeaderValue

HeaderValue(value: String, params: List<HeaderValueParam> = listOf())
val params: List<HeaderValueParam>
val quality: Double
val value: String

enum class HeaderValueEncoding

QUOTED_ALWAYS
QUOTED_WHEN_REQUIRED
URI_ENCODE

data class HeaderValueParam

HeaderValueParam(name: String, value: String)
fun equals(other: Any?): Boolean
fun hashCode(): Int
val name: String
val value: String

abstract class HeaderValueWithParameters

HeaderValueWithParameters(content: String, parameters: List<HeaderValueParam> = emptyList())
protected val content: String
fun parameter(name: String): String?
val parameters: List<HeaderValueParam>
inline fun <R> parse(value: String, init: (String, List<HeaderValueParam>) -> R): R
open fun toString(): String

interface Headers : StringValues

val Empty: Headers
inline fun build(builder: HeadersBuilder.() -> Unit): Headers

class HeadersBuilder : StringValuesBuilder

HeadersBuilder(size: Int = 8)
fun build(): Headers
protected fun validateName(name: String): Unit
protected fun validateValue(value: String): Unit

class HeadersImpl : Headers, StringValuesImpl

HeadersImpl(values: Map<String, List<String>> = emptyMap())
fun toString(): String

class HeadersSingleImpl : Headers, StringValuesSingleImpl

HeadersSingleImpl(name: String, values: List<String>)
fun toString(): String

sealed class HttpAuthHeader

class Parameterized : HttpAuthHeader

Parameterized(authScheme: String, parameters: Map<String, String>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)
Parameterized(authScheme: String, parameters: List<HeaderValueParam>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)
val encoding: HeaderValueEncoding
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun parameter(name: String): String?
val parameters: List<HeaderValueParam>
fun render(encoding: HeaderValueEncoding): String
fun render(): String
fun withParameter(name: String, value: String): Parameterized
fun withReplacedParameter(name: String, value: String): Parameterized

object Parameters

const val Charset: String
const val OAuthCallback: String
const val OAuthCallbackConfirmed: String
const val OAuthConsumerKey: String
const val OAuthNonce: String
const val OAuthSignature: String
const val OAuthSignatureMethod: String
const val OAuthTimestamp: String
const val OAuthToken: String
const val OAuthTokenSecret: String
const val OAuthVerifier: String
const val OAuthVersion: String
const val Realm: String

class Single : HttpAuthHeader

Single(authScheme: String, blob: String)
val blob: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun render(): String
fun render(encoding: HeaderValueEncoding): String

val authScheme: String
fun basicAuthChallenge(realm: String, charset: <ERROR CLASS>?): Parameterized
fun digestAuthChallenge(realm: String, nonce: String = generateNonce(), domain: List<String> = emptyList(), opaque: String? = null, stale: Boolean? = null, algorithm: String = "MD5"): Parameterized
abstract fun render(encoding: HeaderValueEncoding): String
abstract fun render(): String
open fun toString(): String

object HttpHeaders

val ALPN: String
val Accept: String
val AcceptCharset: String
val AcceptEncoding: String
val AcceptLanguage: String
val AcceptRanges: String
val AccessControlAllowCredentials: String
val AccessControlAllowHeaders: String
val AccessControlAllowMethods: String
val AccessControlAllowOrigin: String
val AccessControlExposeHeaders: String
val AccessControlMaxAge: String
val AccessControlRequestHeaders: String
val AccessControlRequestMethod: String
val Age: String
val Allow: String
val AuthenticationInfo: String
val Authorization: String
val CacheControl: String
val Connection: String
val ContentDisposition: String
val ContentEncoding: String
val ContentLanguage: String
val ContentLength: String
val ContentLocation: String
val ContentRange: String
val ContentType: String
val Cookie: String
val DASL: String
val DAV: String
val Date: String
val Depth: String
val Destination: String
val ETag: String
val Expect: String
val Expires: String
val Forwarded: String
val From: String
val HTTP2Settings: String
val Host: String
val If: String
val IfMatch: String
val IfModifiedSince: String
val IfNoneMatch: String
val IfRange: String
val IfScheduleTagMatch: String
val IfUnmodifiedSince: String
val LastModified: String
val Link: String
val Location: String
val LockToken: String
val MIMEVersion: String
val MaxForwards: String
val OrderingType: String
val Origin: String
val Overwrite: String
val Position: String
val Pragma: String
val Prefer: String
val PreferenceApplied: String
val ProxyAuthenticate: String
val ProxyAuthenticationInfo: String
val ProxyAuthorization: String
val PublicKeyPins: String
val PublicKeyPinsReportOnly: String
val Range: String
val Referrer: String
val RetryAfter: String
val SLUG: String
val ScheduleReply: String
val ScheduleTag: String
val SecWebSocketAccept: String
val SecWebSocketExtensions: String
val SecWebSocketKey: String
val SecWebSocketProtocol: String
val SecWebSocketVersion: String
val Server: String
val SetCookie: String
val StrictTransportSecurity: String
val TE: String
val Timeout: String
val Trailer: String
val TransferEncoding: String
val UnsafeHeaders: Array<String>
val UnsafeHeadersList: List<String>
val Upgrade: String
val UserAgent: String
val Vary: String
val Via: String
val WWWAuthenticate: String
val Warning: String
val XCorrelationId: String
val XForwardedFor: String
val XForwardedHost: String
val XForwardedProto: String
val XForwardedServer: String
val XHttpMethodOverride: String
val XRequestId: String
val XTotalCount: String
fun checkHeaderName(name: String): Unit
fun checkHeaderValue(value: String): Unit
fun isUnsafe(header: String): Boolean

interface HttpMessage

abstract val headers: Headers

interface HttpMessageBuilder

abstract val headers: HeadersBuilder

data class HttpMethod

HttpMethod(value: String)
val DefaultMethods: List<HttpMethod>
val Delete: HttpMethod
val Get: HttpMethod
val Head: HttpMethod
val Options: HttpMethod
val Patch: HttpMethod
val Post: HttpMethod
val Put: HttpMethod
fun parse(method: String): HttpMethod
val value: String

data class HttpProtocolVersion

HttpProtocolVersion(name: String, major: Int, minor: Int)
val HTTP_1_0: HttpProtocolVersion
val HTTP_1_1: HttpProtocolVersion
val HTTP_2_0: HttpProtocolVersion
val QUIC: HttpProtocolVersion
val SPDY_3: HttpProtocolVersion
fun fromValue(name: String, major: Int, minor: Int): HttpProtocolVersion
val major: Int
val minor: Int
val name: String
fun parse(value: CharSequence): HttpProtocolVersion
fun toString(): String

data class HttpStatusCode

HttpStatusCode(value: Int, description: String)
val Accepted: HttpStatusCode
val BadGateway: HttpStatusCode
val BadRequest: HttpStatusCode
val Conflict: HttpStatusCode
val Continue: HttpStatusCode
val Created: HttpStatusCode
val ExpectationFailed: HttpStatusCode
val FailedDependency: HttpStatusCode
val Forbidden: HttpStatusCode
val Found: HttpStatusCode
val GatewayTimeout: HttpStatusCode
val Gone: HttpStatusCode
val InsufficientStorage: HttpStatusCode
val InternalServerError: HttpStatusCode
val LengthRequired: HttpStatusCode
val Locked: HttpStatusCode
val MethodNotAllowed: HttpStatusCode
val MovedPermanently: HttpStatusCode
val MultiStatus: HttpStatusCode
val MultipleChoices: HttpStatusCode
val NoContent: HttpStatusCode
val NonAuthoritativeInformation: HttpStatusCode
val NotAcceptable: HttpStatusCode
val NotFound: HttpStatusCode
val NotImplemented: HttpStatusCode
val NotModified: HttpStatusCode
val OK: HttpStatusCode
val PartialContent: HttpStatusCode
val PayloadTooLarge: HttpStatusCode
val PaymentRequired: HttpStatusCode
val PermanentRedirect: HttpStatusCode
val PreconditionFailed: HttpStatusCode
val Processing: HttpStatusCode
val ProxyAuthenticationRequired: HttpStatusCode
val RequestHeaderFieldTooLarge: HttpStatusCode
val RequestTimeout: HttpStatusCode
val RequestURITooLong: HttpStatusCode
val RequestedRangeNotSatisfiable: HttpStatusCode
val ResetContent: HttpStatusCode
val SeeOther: HttpStatusCode
val ServiceUnavailable: HttpStatusCode
val SwitchProxy: HttpStatusCode
val SwitchingProtocols: HttpStatusCode
val TemporaryRedirect: HttpStatusCode
val TooManyRequests: HttpStatusCode
val Unauthorized: HttpStatusCode
val UnprocessableEntity: HttpStatusCode
val UnsupportedMediaType: HttpStatusCode
val UpgradeRequired: HttpStatusCode
val UseProxy: HttpStatusCode
val VariantAlsoNegotiates: HttpStatusCode
val VersionNotSupported: HttpStatusCode
val allStatusCodes: List<HttpStatusCode>
fun description(value: String): HttpStatusCode
val description: String
fun equals(other: Any?): Boolean
fun fromValue(value: Int): HttpStatusCode
fun hashCode(): Int
fun toString(): String
val value: Int

class IllegalHeaderNameException : IllegalArgumentException

IllegalHeaderNameException(headerName: String, position: Int)
val headerName: String
val position: Int

class IllegalHeaderValueException : IllegalArgumentException

IllegalHeaderValueException(headerValue: String, position: Int)
val headerValue: String
val position: Int

data class LastModifiedVersion : Version

LastModifiedVersion(lastModified: Date)
LastModifiedVersion(lastModified: GMTDate)
fun appendHeadersTo(builder: HeadersBuilder): Unit
fun check(requestHeaders: Headers): VersionCheckResult
fun ifModifiedSince(dates: List<GMTDate>): Boolean
fun ifUnmodifiedSince(dates: List<GMTDate>): Boolean
val lastModified: GMTDate

class LinkHeader : HeaderValueWithParameters

LinkHeader(uri: String, rel: String)
LinkHeader(uri: String, vararg rel: String)
LinkHeader(uri: String, rel: List<String>, type: ContentType)
LinkHeader(uri: String, params: List<HeaderValueParam>)
object Parameters

const val Anchor: String
const val HrefLang: String
const val Media: String
const val Rel: String
const val Rev: String
const val Title: String
const val Type: String

object Rel

const val DnsPrefetch: String
const val Next: String
const val PreConnect: String
const val PreLoad: String
const val PreRender: String
const val Prefetch: String
const val Stylesheet: String

val uri: String

interface MultiPartData

object Empty : MultiPartData

suspend fun readPart(): PartData?

abstract suspend fun readPart(): PartData?

sealed class OutgoingContent

abstract class ByteArrayContent : OutgoingContent

ByteArrayContent()
abstract fun bytes(): ByteArray

abstract class NoContent : OutgoingContent

NoContent()

abstract class ProtocolUpgrade : OutgoingContent

ProtocolUpgrade()
val status: HttpStatusCode?
abstract suspend fun upgrade(input: ByteReadChannel, output: ByteWriteChannel, engineContext: <ERROR CLASS>, userContext: <ERROR CLASS>): Job

abstract class ReadChannelContent : OutgoingContent

ReadChannelContent()
abstract fun readFrom(): ByteReadChannel
open fun readFrom(range: LongRange): ByteReadChannel

abstract class WriteChannelContent : OutgoingContent

WriteChannelContent()
abstract suspend fun writeTo(channel: ByteWriteChannel): Unit

open val contentLength: Long?
open val contentType: ContentType?
open fun <T : Any> getProperty(key: AttributeKey<T>): T?
open val headers: Headers
open fun <T : Any> setProperty(key: AttributeKey<T>, value: T?): Unit
open val status: HttpStatusCode?

class OutputStreamContent : WriteChannelContent

OutputStreamContent(body: suspend OutputStream.() -> Unit, contentType: ContentType, status: HttpStatusCode? = null)
val contentType: ContentType
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

interface Parameters : StringValues

val Empty: Parameters
inline fun build(builder: ParametersBuilder.() -> Unit): Parameters

class ParametersBuilder : StringValuesBuilder

ParametersBuilder(size: Int = 8)
fun build(): Parameters

class ParametersImpl : Parameters, StringValuesImpl

ParametersImpl(values: Map<String, List<String>> = emptyMap())
fun toString(): String

class ParametersSingleImpl : Parameters, StringValuesSingleImpl

ParametersSingleImpl(name: String, values: List<String>)
fun toString(): String

class ParseException : IllegalArgumentException

ParseException(message: String, cause: Throwable? = null)
val cause: Throwable?
val message: String

sealed class PartData

class BinaryItem : PartData

BinaryItem(provider: () -> Input, dispose: () -> Unit, partHeaders: Headers)
val provider: () -> Input

class FileItem : PartData

FileItem(provider: () -> Input, dispose: () -> Unit, partHeaders: Headers)
val originalFileName: String?
val provider: () -> Input

class FormItem : PartData

FormItem(value: String, dispose: () -> Unit, partHeaders: Headers)
val value: String

val contentDisposition: ContentDisposition?
val contentType: ContentType?
val dispose: () -> Unit
val headers: Headers
val name: String?
val partHeaders: Headers
val partName: String?

enum class RangeUnits

Bytes
None
val unitToken: String

data class RangesSpecifier

RangesSpecifier(unit: RangeUnits, ranges: List<ContentRange>)
RangesSpecifier(unit: String = RangeUnits.Bytes.unitToken, ranges: List<ContentRange>)
fun isValid(rangeUnitPredicate: (String) -> Boolean = { it == RangeUnits.Bytes.unitToken }): Boolean
fun merge(length: Long, maxRangeCount: Int = 50): List<LongRange>
fun merge(length: Long): List<LongRange>
fun mergeToSingle(length: Long): LongRange?
val ranges: List<ContentRange>
fun toString(): String
val unit: String

interface RequestConnectionPoint

abstract val host: String
abstract val method: HttpMethod
abstract val port: Int
abstract val remoteHost: String
abstract val scheme: String
abstract val uri: String
abstract val version: String

typealias TextContent = TextContent
class TextContent : ByteArrayContent

TextContent(text: String, contentType: ContentType, status: HttpStatusCode? = null)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType
val status: HttpStatusCode?
val text: String
fun toString(): String

class URIFileContent : ReadChannelContent

URIFileContent(url: URL, contentType: ContentType = ContentType.defaultForFilePath(url.path))
URIFileContent(uri: URI, contentType: ContentType = ContentType.defaultForFilePath(uri.path))
val contentType: ContentType
fun readFrom(): ByteReadChannel
val uri: URI

class URLBuilder

URLBuilder(protocol: URLProtocol = URLProtocol.HTTP, host: String = "localhost", port: Int = DEFAULT_PORT, user: String? = null, password: String? = null, encodedPath: String = "/", parameters: ParametersBuilder = ParametersBuilder(), fragment: String = "", trailingQuery: Boolean = false)
fun build(): Url
fun buildString(): String
var encodedPath: String
var fragment: String
var host: String
val parameters: ParametersBuilder
var password: String?
fun path(vararg components: String): URLBuilder
fun path(components: List<String>): URLBuilder
var port: Int
var protocol: URLProtocol
var trailingQuery: Boolean
var user: String?

class URLDecodeException : Exception

URLDecodeException(message: String)

class URLParserException : IllegalStateException

URLParserException(urlString: String, cause: Throwable)

data class URLProtocol

URLProtocol(name: String, defaultPort: Int)
val HTTP: URLProtocol
val HTTPS: URLProtocol
val SOCKS: URLProtocol
val WS: URLProtocol
val WSS: URLProtocol
val byName: Map<String, URLProtocol>
fun createOrDefault(name: String): URLProtocol
val defaultPort: Int
val name: String

class UnsafeHeaderException : IllegalArgumentException

UnsafeHeaderException(header: String)

data class Url

Url(protocol: URLProtocol, host: String, specifiedPort: Int, encodedPath: String, parameters: Parameters, fragment: String, user: String?, password: String?, trailingQuery: Boolean)
val encodedPath: String
val fragment: String
val host: String
val parameters: Parameters
val password: String?
val port: Int
val protocol: URLProtocol
val specifiedPort: Int
fun toString(): String
val trailingQuery: Boolean
val user: String?

interface Version

abstract fun appendHeadersTo(builder: HeadersBuilder): Unit
abstract fun check(requestHeaders: Headers): VersionCheckResult

enum class VersionCheckResult

NOT_MODIFIED
OK
PRECONDITION_FAILED
val statusCode: HttpStatusCode

class WriterContent : WriteChannelContent

WriterContent(body: suspend Writer.() -> Unit, contentType: ContentType, status: HttpStatusCode? = null)
val contentType: ContentType
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

io.ktor.util.StringValuesBuilder

fun StringValuesBuilder.append(name: String, value: HeaderValueWithParameters): Unit

io.ktor.util.date.GMTDate

fun GMTDate.toHttpDate(): String

kotlin.String

fun String.decodeURLPart(start: Int = 0, end: Int = length, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.decodeURLQueryComponent(start: Int = 0, end: Int = length, plusIsSpace: Boolean = false, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.encodeOAuth(): String
fun String.encodeURLParameter(spaceToPlus: Boolean = false): String
fun String.encodeURLPath(): String
fun String.encodeURLQueryComponent(encodeFull: Boolean = false, spaceToPlus: Boolean = false, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.escapeIfNeeded(): String
fun String.fromCookieToGmtDate(): GMTDate
fun String.fromHttpToGmtDate(): GMTDate
fun String.parseUrlEncodedParameters(defaultEncoding: <ERROR CLASS> = Charsets.UTF_8, limit: Int = 1000): Parameters
fun String.quote(): String

kotlin.collections.Iterable

fun Iterable<Pair<String, String>>.toHeaderParamsList(): List<HeaderValueParam>

kotlin.collections.List

fun List<Pair<String, String?>>.formUrlEncode(): String
fun List<Pair<String, String?>>.formUrlEncodeTo(out: Appendable): Unit

package io.ktor.content

typealias ByteArrayContent = ByteArrayContent
typealias TextContent = TextContent

package io.ktor.http

class BadContentTypeFormatException : Exception

BadContentTypeFormatException(value: String)

sealed class CacheControl

class MaxAge : CacheControl

MaxAge(maxAgeSeconds: Int, proxyMaxAgeSeconds: Int? = null, mustRevalidate: Boolean = false, proxyRevalidate: Boolean = false, visibility: Visibility? = null)
fun equals(other: Any?): Boolean
fun hashCode(): Int
val maxAgeSeconds: Int
val mustRevalidate: Boolean
val proxyMaxAgeSeconds: Int?
val proxyRevalidate: Boolean
fun toString(): String

class NoCache : CacheControl

NoCache(visibility: Visibility?)
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

class NoStore : CacheControl

NoStore(visibility: Visibility?)
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

enum class Visibility

Private
Public

val visibility: Visibility?

class ContentDisposition : HeaderValueWithParameters

ContentDisposition(disposition: String, parameters: List<HeaderValueParam> = emptyList())
val Attachment: ContentDisposition
val File: ContentDisposition
val Inline: ContentDisposition
val Mixed: ContentDisposition
object Parameters

const val CreationDate: String
const val FileName: String
const val FileNameAsterisk: String
const val Handling: String
const val ModificationDate: String
const val Name: String
const val ReadDate: String
const val Size: String

val disposition: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
val name: String?
fun parse(value: String): ContentDisposition
fun withParameter(key: String, value: String): ContentDisposition
fun withParameters(newParameters: List<HeaderValueParam>): ContentDisposition

sealed class ContentRange

data class Bounded : ContentRange

Bounded(from: Long, to: Long)
val from: Long
val to: Long
fun toString(): String

data class Suffix : ContentRange

Suffix(lastCount: Long)
val lastCount: Long
fun toString(): String

data class TailFrom : ContentRange

TailFrom(from: Long)
val from: Long
fun toString(): String

class ContentType : HeaderValueWithParameters

ContentType(contentType: String, contentSubtype: String, parameters: List<HeaderValueParam> = emptyList())
val Any: ContentType
object Application

val Any: ContentType
val Atom: ContentType
val Cbor: ContentType
val FontWoff: ContentType
val FormUrlEncoded: ContentType
val GZip: ContentType
val HalJson: ContentType
val JavaScript: ContentType
val Json: ContentType
val OctetStream: ContentType
val Pdf: ContentType
val ProblemJson: ContentType
val ProblemXml: ContentType
val ProtoBuf: ContentType
val Rss: ContentType
val Wasm: ContentType
val Xml: ContentType
val Xml_Dtd: ContentType
val Zip: ContentType

object Audio

val Any: ContentType
val MP4: ContentType
val MPEG: ContentType
val OGG: ContentType

object Image

val Any: ContentType
val GIF: ContentType
val JPEG: ContentType
val PNG: ContentType
val SVG: ContentType
val XIcon: ContentType

object Message

val Any: ContentType
val Http: ContentType

object MultiPart

val Alternative: ContentType
val Any: ContentType
val ByteRanges: ContentType
val Encrypted: ContentType
val FormData: ContentType
val Mixed: ContentType
val Related: ContentType
val Signed: ContentType

object Text

val Any: ContentType
val CSS: ContentType
val CSV: ContentType
val EventStream: ContentType
val Html: ContentType
val JavaScript: ContentType
val Plain: ContentType
val VCard: ContentType
val Xml: ContentType

object Video

val Any: ContentType
val MP4: ContentType
val MPEG: ContentType
val OGG: ContentType
val QuickTime: ContentType

val contentSubtype: String
val contentType: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun match(pattern: ContentType): Boolean
fun match(pattern: String): Boolean
fun parse(value: String): ContentType
fun withParameter(name: String, value: String): ContentType
fun withoutParameters(): ContentType

interface ContentTypeMatcher

abstract fun contains(contentType: ContentType): Boolean

data class Cookie

Cookie(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap())
val domain: String?
val encoding: CookieEncoding
val expires: GMTDate?
val extensions: Map<String, String?>
fun getMaxAge(): Int
val httpOnly: Boolean
val maxAge: Int
val name: String
val path: String?
val secure: Boolean
val value: String

enum class CookieEncoding

BASE64_ENCODING
DQUOTES
RAW
URI_ENCODING

const val DEFAULT_PORT: Int
object EmptyHeaders : Headers

val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>
fun toString(): String

object EmptyParameters : Parameters

val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun equals(other: Any?): Boolean
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>
fun toString(): String

inline val HttpStatusCode.Companion.ExceptionFailed: HttpStatusCode
data class HeaderValue

HeaderValue(value: String, params: List<HeaderValueParam> = listOf())
val params: List<HeaderValueParam>
val quality: Double
val value: String

data class HeaderValueParam

HeaderValueParam(name: String, value: String)
fun equals(other: Any?): Boolean
fun hashCode(): Int
val name: String
val value: String

abstract class HeaderValueWithParameters

HeaderValueWithParameters(content: String, parameters: List<HeaderValueParam> = emptyList())
protected val content: String
fun parameter(name: String): String?
val parameters: List<HeaderValueParam>
inline fun <R> parse(value: String, init: (String, List<HeaderValueParam>) -> R): R
open fun toString(): String

interface Headers : StringValues

val Empty: Headers
inline fun build(builder: HeadersBuilder.() -> Unit): Headers

class HeadersBuilder : StringValuesBuilder

HeadersBuilder(size: Int = 8)
fun build(): Headers
protected fun validateName(name: String): Unit
protected fun validateValue(value: String): Unit

class HeadersImpl : Headers, StringValuesImpl

HeadersImpl(values: Map<String, List<String>> = emptyMap())
fun toString(): String

class HeadersSingleImpl : Headers, StringValuesSingleImpl

HeadersSingleImpl(name: String, values: List<String>)
fun toString(): String

object HttpHeaders

val ALPN: String
val Accept: String
val AcceptCharset: String
val AcceptEncoding: String
val AcceptLanguage: String
val AcceptRanges: String
val AccessControlAllowCredentials: String
val AccessControlAllowHeaders: String
val AccessControlAllowMethods: String
val AccessControlAllowOrigin: String
val AccessControlExposeHeaders: String
val AccessControlMaxAge: String
val AccessControlRequestHeaders: String
val AccessControlRequestMethod: String
val Age: String
val Allow: String
val AuthenticationInfo: String
val Authorization: String
val CacheControl: String
val Connection: String
val ContentDisposition: String
val ContentEncoding: String
val ContentLanguage: String
val ContentLength: String
val ContentLocation: String
val ContentRange: String
val ContentType: String
val Cookie: String
val DASL: String
val DAV: String
val Date: String
val Depth: String
val Destination: String
val ETag: String
val Expect: String
val Expires: String
val Forwarded: String
val From: String
val HTTP2Settings: String
val Host: String
val If: String
val IfMatch: String
val IfModifiedSince: String
val IfNoneMatch: String
val IfRange: String
val IfScheduleTagMatch: String
val IfUnmodifiedSince: String
val LastModified: String
val Link: String
val Location: String
val LockToken: String
val MIMEVersion: String
val MaxForwards: String
val OrderingType: String
val Origin: String
val Overwrite: String
val Position: String
val Pragma: String
val Prefer: String
val PreferenceApplied: String
val ProxyAuthenticate: String
val ProxyAuthenticationInfo: String
val ProxyAuthorization: String
val PublicKeyPins: String
val PublicKeyPinsReportOnly: String
val Range: String
val Referrer: String
val RetryAfter: String
val SLUG: String
val ScheduleReply: String
val ScheduleTag: String
val SecWebSocketAccept: String
val SecWebSocketExtensions: String
val SecWebSocketKey: String
val SecWebSocketProtocol: String
val SecWebSocketVersion: String
val Server: String
val SetCookie: String
val StrictTransportSecurity: String
val TE: String
val Timeout: String
val Trailer: String
val TransferEncoding: String
val UnsafeHeaders: Array<String>
val UnsafeHeadersList: List<String>
val Upgrade: String
val UserAgent: String
val Vary: String
val Via: String
val WWWAuthenticate: String
val Warning: String
val XCorrelationId: String
val XForwardedFor: String
val XForwardedHost: String
val XForwardedProto: String
val XForwardedServer: String
val XHttpMethodOverride: String
val XRequestId: String
val XTotalCount: String
fun checkHeaderName(name: String): Unit
fun checkHeaderValue(value: String): Unit
fun isUnsafe(header: String): Boolean

interface HttpMessage

abstract val headers: Headers

interface HttpMessageBuilder

abstract val headers: HeadersBuilder

data class HttpMethod

HttpMethod(value: String)
val DefaultMethods: List<HttpMethod>
val Delete: HttpMethod
val Get: HttpMethod
val Head: HttpMethod
val Options: HttpMethod
val Patch: HttpMethod
val Post: HttpMethod
val Put: HttpMethod
fun parse(method: String): HttpMethod
val value: String

data class HttpProtocolVersion

HttpProtocolVersion(name: String, major: Int, minor: Int)
val HTTP_1_0: HttpProtocolVersion
val HTTP_1_1: HttpProtocolVersion
val HTTP_2_0: HttpProtocolVersion
val QUIC: HttpProtocolVersion
val SPDY_3: HttpProtocolVersion
fun fromValue(name: String, major: Int, minor: Int): HttpProtocolVersion
val major: Int
val minor: Int
val name: String
fun parse(value: CharSequence): HttpProtocolVersion
fun toString(): String

data class HttpStatusCode

HttpStatusCode(value: Int, description: String)
val Accepted: HttpStatusCode
val BadGateway: HttpStatusCode
val BadRequest: HttpStatusCode
val Conflict: HttpStatusCode
val Continue: HttpStatusCode
val Created: HttpStatusCode
val ExpectationFailed: HttpStatusCode
val FailedDependency: HttpStatusCode
val Forbidden: HttpStatusCode
val Found: HttpStatusCode
val GatewayTimeout: HttpStatusCode
val Gone: HttpStatusCode
val InsufficientStorage: HttpStatusCode
val InternalServerError: HttpStatusCode
val LengthRequired: HttpStatusCode
val Locked: HttpStatusCode
val MethodNotAllowed: HttpStatusCode
val MovedPermanently: HttpStatusCode
val MultiStatus: HttpStatusCode
val MultipleChoices: HttpStatusCode
val NoContent: HttpStatusCode
val NonAuthoritativeInformation: HttpStatusCode
val NotAcceptable: HttpStatusCode
val NotFound: HttpStatusCode
val NotImplemented: HttpStatusCode
val NotModified: HttpStatusCode
val OK: HttpStatusCode
val PartialContent: HttpStatusCode
val PayloadTooLarge: HttpStatusCode
val PaymentRequired: HttpStatusCode
val PermanentRedirect: HttpStatusCode
val PreconditionFailed: HttpStatusCode
val Processing: HttpStatusCode
val ProxyAuthenticationRequired: HttpStatusCode
val RequestHeaderFieldTooLarge: HttpStatusCode
val RequestTimeout: HttpStatusCode
val RequestURITooLong: HttpStatusCode
val RequestedRangeNotSatisfiable: HttpStatusCode
val ResetContent: HttpStatusCode
val SeeOther: HttpStatusCode
val ServiceUnavailable: HttpStatusCode
val SwitchProxy: HttpStatusCode
val SwitchingProtocols: HttpStatusCode
val TemporaryRedirect: HttpStatusCode
val TooManyRequests: HttpStatusCode
val Unauthorized: HttpStatusCode
val UnprocessableEntity: HttpStatusCode
val UnsupportedMediaType: HttpStatusCode
val UpgradeRequired: HttpStatusCode
val UseProxy: HttpStatusCode
val VariantAlsoNegotiates: HttpStatusCode
val VersionNotSupported: HttpStatusCode
val allStatusCodes: List<HttpStatusCode>
fun description(value: String): HttpStatusCode
val description: String
fun equals(other: Any?): Boolean
fun fromValue(value: Int): HttpStatusCode
fun hashCode(): Int
fun toString(): String
val value: Int

class IllegalHeaderNameException : IllegalArgumentException

IllegalHeaderNameException(headerName: String, position: Int)
val headerName: String
val position: Int

class IllegalHeaderValueException : IllegalArgumentException

IllegalHeaderValueException(headerValue: String, position: Int)
val headerValue: String
val position: Int

class LinkHeader : HeaderValueWithParameters

LinkHeader(uri: String, rel: String)
LinkHeader(uri: String, vararg rel: String)
LinkHeader(uri: String, rel: List<String>, type: ContentType)
LinkHeader(uri: String, params: List<HeaderValueParam>)
object Parameters

const val Anchor: String
const val HrefLang: String
const val Media: String
const val Rel: String
const val Rev: String
const val Title: String
const val Type: String

object Rel

const val DnsPrefetch: String
const val Next: String
const val PreConnect: String
const val PreLoad: String
const val PreRender: String
const val Prefetch: String
const val Stylesheet: String

val uri: String

interface Parameters : StringValues

val Empty: Parameters
inline fun build(builder: ParametersBuilder.() -> Unit): Parameters

class ParametersBuilder : StringValuesBuilder

ParametersBuilder(size: Int = 8)
fun build(): Parameters

class ParametersImpl : Parameters, StringValuesImpl

ParametersImpl(values: Map<String, List<String>> = emptyMap())
fun toString(): String

class ParametersSingleImpl : Parameters, StringValuesSingleImpl

ParametersSingleImpl(name: String, values: List<String>)
fun toString(): String

enum class RangeUnits

Bytes
None
val unitToken: String

data class RangesSpecifier

RangesSpecifier(unit: RangeUnits, ranges: List<ContentRange>)
RangesSpecifier(unit: String = RangeUnits.Bytes.unitToken, ranges: List<ContentRange>)
fun isValid(rangeUnitPredicate: (String) -> Boolean = { it == RangeUnits.Bytes.unitToken }): Boolean
fun merge(length: Long, maxRangeCount: Int = 50): List<LongRange>
fun merge(length: Long): List<LongRange>
fun mergeToSingle(length: Long): LongRange?
val ranges: List<ContentRange>
fun toString(): String
val unit: String

interface RequestConnectionPoint

abstract val host: String
abstract val method: HttpMethod
abstract val port: Int
abstract val remoteHost: String
abstract val scheme: String
abstract val uri: String
abstract val version: String

class URLBuilder

URLBuilder(protocol: URLProtocol = URLProtocol.HTTP, host: String = "localhost", port: Int = DEFAULT_PORT, user: String? = null, password: String? = null, encodedPath: String = "/", parameters: ParametersBuilder = ParametersBuilder(), fragment: String = "", trailingQuery: Boolean = false)
fun build(): Url
fun buildString(): String
var encodedPath: String
var fragment: String
var host: String
val parameters: ParametersBuilder
var password: String?
fun path(vararg components: String): URLBuilder
fun path(components: List<String>): URLBuilder
var port: Int
var protocol: URLProtocol
var trailingQuery: Boolean
var user: String?

fun URLBuilder(urlString: String): URLBuilder
fun URLBuilder(url: Url): URLBuilder
fun URLBuilder(builder: URLBuilder): URLBuilder
class URLDecodeException : Exception

URLDecodeException(message: String)

class URLParserException : IllegalStateException

URLParserException(urlString: String, cause: Throwable)

data class URLProtocol

URLProtocol(name: String, defaultPort: Int)
val HTTP: URLProtocol
val HTTPS: URLProtocol
val SOCKS: URLProtocol
val WS: URLProtocol
val WSS: URLProtocol
val byName: Map<String, URLProtocol>
fun createOrDefault(name: String): URLProtocol
val defaultPort: Int
val name: String

class UnsafeHeaderException : IllegalArgumentException

UnsafeHeaderException(header: String)

data class Url

Url(protocol: URLProtocol, host: String, specifiedPort: Int, encodedPath: String, parameters: Parameters, fragment: String, user: String?, password: String?, trailingQuery: Boolean)
val encodedPath: String
val fragment: String
val host: String
val parameters: Parameters
val password: String?
val port: Int
val protocol: URLProtocol
val specifiedPort: Int
fun toString(): String
val trailingQuery: Boolean
val user: String?

fun Url(urlString: String): Url
fun Url(builder: URLBuilder): Url
fun Url(uri: URI): Url
val Url.authority: String
val URLBuilder.authority: String
fun HttpMessage.cacheControl(): List<HeaderValue>
fun HeaderValueWithParameters.charset(): <ERROR CLASS>?
fun HttpMessageBuilder.charset(charset: <ERROR CLASS>): Unit?
fun HttpMessageBuilder.charset(): <ERROR CLASS>?
fun HttpMessage.charset(): <ERROR CLASS>?
fun URLBuilder.clone(): URLBuilder
fun HttpMessageBuilder.contentLength(length: Int): Unit
fun HttpMessageBuilder.contentLength(): Long?
fun HttpMessage.contentLength(): Long?
fun contentRangeHeaderValue(range: LongRange?, fullLength: Long? = null, unit: RangeUnits = RangeUnits.Bytes): String
fun contentRangeHeaderValue(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken): String
fun HttpMessageBuilder.contentType(type: ContentType): Unit
fun HttpMessageBuilder.contentType(): ContentType?
fun HttpMessage.contentType(): ContentType?
fun HttpMessageBuilder.cookies(): List<Cookie>
fun HttpMessage.date(): Date?
fun decodeCookieValue(encodedValue: String, encoding: CookieEncoding): String
fun ContentType.Companion.defaultForFile(file: File): ContentType
fun ContentType.Companion.defaultForFile(file: Path): ContentType
fun ContentType.Companion.defaultForFileExtension(extension: String): ContentType
fun ContentType.Companion.defaultForFilePath(path: String): ContentType
fun encodeCookieValue(value: String, encoding: CookieEncoding): String
fun HeadersBuilder.etag(entityTag: String): Unit
fun HttpMessageBuilder.etag(): String?
fun HttpMessage.etag(): String?
fun HttpMessageBuilder.expires(): Date?
fun HttpMessage.expires(): Date?
fun ContentType.fileExtensions(): List<String>
fun Parameters.formUrlEncode(): String
fun Parameters.formUrlEncodeTo(out: Appendable): Unit
fun ContentType.Companion.fromFileExtension(ext: String): List<ContentType>
fun ContentType.Companion.fromFilePath(path: String): List<ContentType>
val Url.fullPath: String
fun headersOf(): Headers
fun headersOf(name: String, value: String): Headers
fun headersOf(name: String, values: List<String>): Headers
fun headersOf(vararg pairs: Pair<String, List<String>>): Headers
fun hostIsIp(host: String): Boolean
val Url.hostWithPort: String
fun HttpMessageBuilder.ifModifiedSince(date: Date): Unit
fun HttpMessageBuilder.ifNoneMatch(value: String): Unit
operator fun Url.Companion.invoke(fullUrl: String): Url
io.ktor.util.StringValuesBuilder

fun StringValuesBuilder.append(name: String, value: HeaderValueWithParameters): Unit

io.ktor.util.date.GMTDate

fun GMTDate.toHttpDate(): String

fun URLProtocol.isSecure(): Boolean
fun HttpStatusCode.isSuccess(): Boolean
fun URLProtocol.isWebsocket(): Boolean
kotlin.String

fun String.decodeURLPart(start: Int = 0, end: Int = length, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.decodeURLQueryComponent(start: Int = 0, end: Int = length, plusIsSpace: Boolean = false, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.encodeOAuth(): String
fun String.encodeURLParameter(spaceToPlus: Boolean = false): String
fun String.encodeURLPath(): String
fun String.encodeURLQueryComponent(encodeFull: Boolean = false, spaceToPlus: Boolean = false, charset: <ERROR CLASS> = Charsets.UTF_8): String
fun String.escapeIfNeeded(): String
fun String.fromCookieToGmtDate(): GMTDate
fun String.fromHttpToGmtDate(): GMTDate
fun String.parseUrlEncodedParameters(defaultEncoding: <ERROR CLASS> = Charsets.UTF_8, limit: Int = 1000): Parameters
fun String.quote(): String

kotlin.collections.Iterable

fun Iterable<Pair<String, String>>.toHeaderParamsList(): List<HeaderValueParam>

kotlin.collections.List

fun List<Pair<String, String?>>.formUrlEncode(): String
fun List<Pair<String, String?>>.formUrlEncodeTo(out: Appendable): Unit

fun HttpMessageBuilder.lastModified(): Date?
fun HttpMessage.lastModified(): Date?
fun HttpMessageBuilder.maxAge(seconds: Int): Unit
fun parametersOf(): Parameters
fun parametersOf(name: String, value: String): Parameters
fun parametersOf(name: String, values: List<String>): Parameters
fun parametersOf(vararg pairs: Pair<String, List<String>>): Parameters
fun parseAndSortContentTypeHeader(header: String?): List<HeaderValue>
fun parseAndSortHeader(header: String?): List<HeaderValue>
fun parseClientCookiesHeader(cookiesHeader: String, skipEscaped: Boolean = true): Map<String, String>
fun parseHeaderValue(text: String?): List<HeaderValue>
fun parseHeaderValue(text: String?, parametersOnly: Boolean): List<HeaderValue>
fun parseQueryString(query: String, startIndex: Int = 0, limit: Int = 1000): Parameters
fun parseRangesSpecifier(rangeSpec: String): RangesSpecifier?
fun parseServerSetCookieHeader(cookiesHeader: String): Cookie
fun URLBuilder.pathComponents(components: List<String>): URLBuilder
fun URLBuilder.pathComponents(vararg components: String): URLBuilder
operator fun Parameters.plus(other: Parameters): Parameters
fun renderCookieHeader(cookie: Cookie): String
fun renderSetCookieHeader(cookie: Cookie): String
fun renderSetCookieHeader(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap(), includeEncoding: Boolean = true): String
fun HttpMessage.setCookie(): List<Cookie>
fun URLBuilder.takeFrom(urlString: String): URLBuilder
fun URLBuilder.takeFrom(url: URLBuilder): URLBuilder
fun URLBuilder.takeFrom(url: Url): URLBuilder
fun URLBuilder.takeFrom(uri: URI): URLBuilder
fun URLBuilder.takeFrom(url: URL): URLBuilder
fun Url.toURI(): URI
fun HttpMessageBuilder.userAgent(content: String): Unit
fun HttpMessageBuilder.vary(): List<String>?
fun HttpMessage.vary(): List<String>?
fun ContentType.withCharset(charset: <ERROR CLASS>): ContentType

package io.ktor.http.auth

object AuthScheme

const val Basic: String
const val Digest: String
const val Negotiate: String
const val OAuth: String
fun getBasic(): String
fun getDigest(): String
fun getNegotiate(): String

enum class HeaderValueEncoding

QUOTED_ALWAYS
QUOTED_WHEN_REQUIRED
URI_ENCODE

sealed class HttpAuthHeader

class Parameterized : HttpAuthHeader

Parameterized(authScheme: String, parameters: Map<String, String>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)
Parameterized(authScheme: String, parameters: List<HeaderValueParam>, encoding: HeaderValueEncoding = HeaderValueEncoding.QUOTED_WHEN_REQUIRED)
val encoding: HeaderValueEncoding
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun parameter(name: String): String?
val parameters: List<HeaderValueParam>
fun render(encoding: HeaderValueEncoding): String
fun render(): String
fun withParameter(name: String, value: String): Parameterized
fun withReplacedParameter(name: String, value: String): Parameterized

object Parameters

const val Charset: String
const val OAuthCallback: String
const val OAuthCallbackConfirmed: String
const val OAuthConsumerKey: String
const val OAuthNonce: String
const val OAuthSignature: String
const val OAuthSignatureMethod: String
const val OAuthTimestamp: String
const val OAuthToken: String
const val OAuthTokenSecret: String
const val OAuthVerifier: String
const val OAuthVersion: String
const val Realm: String

class Single : HttpAuthHeader

Single(authScheme: String, blob: String)
val blob: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun render(): String
fun render(encoding: HeaderValueEncoding): String

val authScheme: String
fun basicAuthChallenge(realm: String, charset: <ERROR CLASS>?): Parameterized
fun digestAuthChallenge(realm: String, nonce: String = generateNonce(), domain: List<String> = emptyList(), opaque: String? = null, stale: Boolean? = null, algorithm: String = "MD5"): Parameterized
abstract fun render(encoding: HeaderValueEncoding): String
abstract fun render(): String
open fun toString(): String

fun parseAuthorizationHeader(headerValue: String): HttpAuthHeader?

package io.ktor.http.content

class ByteArrayContent : ByteArrayContent

ByteArrayContent(bytes: ByteArray, contentType: ContentType? = null, status: HttpStatusCode? = null)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType?
val status: HttpStatusCode?

data class CachingOptions

CachingOptions(cacheControl: CacheControl? = null, expires: GMTDate? = null)
val cacheControl: CacheControl?
val expires: GMTDate?

val CachingProperty: AttributeKey<CachingOptions>
class ChannelWriterContent : WriteChannelContent

ChannelWriterContent(body: suspend ByteWriteChannel.() -> Unit, contentType: ContentType?, status: HttpStatusCode? = null)
val contentType: ContentType?
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

fun EntityTagVersion(spec: String): EntityTagVersion
data class EntityTagVersion : Version

EntityTagVersion(etag: String)
EntityTagVersion(etag: String, weak: Boolean)
val STAR: EntityTagVersion
fun appendHeadersTo(builder: HeadersBuilder): Unit
fun check(requestHeaders: Headers): VersionCheckResult
val etag: String
fun match(other: EntityTagVersion): Boolean
fun match(givenMatchEtags: List<EntityTagVersion>): VersionCheckResult
fun noneMatch(givenNoneMatchEtags: List<EntityTagVersion>): VersionCheckResult
fun parse(headerValue: String): List<EntityTagVersion>
fun parseSingle(value: String): EntityTagVersion
val weak: Boolean

data class LastModifiedVersion : Version

LastModifiedVersion(lastModified: Date)
LastModifiedVersion(lastModified: GMTDate)
fun appendHeadersTo(builder: HeadersBuilder): Unit
fun check(requestHeaders: Headers): VersionCheckResult
fun ifModifiedSince(dates: List<GMTDate>): Boolean
fun ifUnmodifiedSince(dates: List<GMTDate>): Boolean
val lastModified: GMTDate

interface MultiPartData

object Empty : MultiPartData

suspend fun readPart(): PartData?

abstract suspend fun readPart(): PartData?

sealed class OutgoingContent

abstract class ByteArrayContent : OutgoingContent

ByteArrayContent()
abstract fun bytes(): ByteArray

abstract class NoContent : OutgoingContent

NoContent()

abstract class ProtocolUpgrade : OutgoingContent

ProtocolUpgrade()
val status: HttpStatusCode?
abstract suspend fun upgrade(input: ByteReadChannel, output: ByteWriteChannel, engineContext: <ERROR CLASS>, userContext: <ERROR CLASS>): Job

abstract class ReadChannelContent : OutgoingContent

ReadChannelContent()
abstract fun readFrom(): ByteReadChannel
open fun readFrom(range: LongRange): ByteReadChannel

abstract class WriteChannelContent : OutgoingContent

WriteChannelContent()
abstract suspend fun writeTo(channel: ByteWriteChannel): Unit

open val contentLength: Long?
open val contentType: ContentType?
open fun <T : Any> getProperty(key: AttributeKey<T>): T?
open val headers: Headers
open fun <T : Any> setProperty(key: AttributeKey<T>, value: T?): Unit
open val status: HttpStatusCode?

class OutputStreamContent : WriteChannelContent

OutputStreamContent(body: suspend OutputStream.() -> Unit, contentType: ContentType, status: HttpStatusCode? = null)
val contentType: ContentType
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

sealed class PartData

class BinaryItem : PartData

BinaryItem(provider: () -> Input, dispose: () -> Unit, partHeaders: Headers)
val provider: () -> Input

class FileItem : PartData

FileItem(provider: () -> Input, dispose: () -> Unit, partHeaders: Headers)
val originalFileName: String?
val provider: () -> Input

class FormItem : PartData

FormItem(value: String, dispose: () -> Unit, partHeaders: Headers)
val value: String

val contentDisposition: ContentDisposition?
val contentType: ContentType?
val dispose: () -> Unit
val headers: Headers
val name: String?
val partHeaders: Headers
val partName: String?

class TextContent : ByteArrayContent

TextContent(text: String, contentType: ContentType, status: HttpStatusCode? = null)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType
val status: HttpStatusCode?
val text: String
fun toString(): String

class URIFileContent : ReadChannelContent

URIFileContent(url: URL, contentType: ContentType = ContentType.defaultForFilePath(url.path))
URIFileContent(uri: URI, contentType: ContentType = ContentType.defaultForFilePath(uri.path))
val contentType: ContentType
fun readFrom(): ByteReadChannel
val uri: URI

interface Version

abstract fun appendHeadersTo(builder: HeadersBuilder): Unit
abstract fun check(requestHeaders: Headers): VersionCheckResult

enum class VersionCheckResult

NOT_MODIFIED
OK
PRECONDITION_FAILED
val statusCode: HttpStatusCode

val VersionListProperty: AttributeKey<List<Version>>
class WriterContent : WriteChannelContent

WriterContent(body: suspend Writer.() -> Unit, contentType: ContentType, status: HttpStatusCode? = null)
val contentType: ContentType
val status: HttpStatusCode?
suspend fun writeTo(channel: ByteWriteChannel): Unit

var OutgoingContent.caching: CachingOptions?
suspend fun MultiPartData.forEachPart(partHandler: suspend (PartData) -> Unit): Unit
suspend fun MultiPartData.readAllParts(): List<PartData>
val FileItem.streamProvider: () -> InputStream
var OutgoingContent.versions: List<Version>

package io.ktor.http.parsing

class ParseException : IllegalArgumentException

ParseException(message: String, cause: Throwable? = null)
val cause: Throwable?
val message: String

package io.ktor.http.websocket

fun websocketServerAccept(nonce: String): String