io.outfoxx.sunday.http

HeaderNames

object HeaderNames

Commonly used HTTP header names.

HeaderParameters

object HeaderParameters

Encoding of parameters into headers.

Headers

typealias Headers = Iterable<Pair<String, String>>

HTTP Headers.

Method

data class Method(val name: String, val requiresBody: Boolean = false)

HTTP Request Method.

Parameters

typealias Parameters = Map<String, Any?>

Parameters map.

Request

interface Request

HTTP request based on coroutines.

Response

interface Response

HTTP response.

ResultResponse

data class ResultResponse<T : Any>(val result: T, response: Response) : Response

HTTP response that includes a parsed/decoded result.

getAll

fun Headers.getAll(name: String): Iterable<String>

Retrieves all the headers matching the given name.

getFirst

fun Headers.getFirst(name: String): String

Retrieves the first header matching the given name or throws an error.

getFirstOrNull

fun Headers.getFirstOrNull(name: String): String?

Retrieves the first header matching the given name or returns null.

toMultiMap

fun Headers.toMultiMap(): Map<String, List<String>>

Converts the header list into an equivalent multi-map.

contentLength

val Response.contentLength: Long?

Convenience accessor for HTTP Content-Length header.

contentType

val Response.contentType: MediaType?

Convenience accessor for HTTP Content-Type header.

isSuccessful

val Response.isSuccessful: Boolean

Convenience for checking if the Response.statusCode represents a successful response.

Package-level declarations

Types

Functions

Properties