http/aws.smithy.kotlin.runtime.http.request

Package-level declarations

Types

HttpRequest

sealed interface HttpRequest

Immutable representation of an HTTP request

HttpRequestBuilder

class HttpRequestBuilder

Used to construct an HTTP request

Functions

dumpRequest

suspend fun dumpRequest(request: HttpRequestBuilder, dumpBody: Boolean): String

Dump a debug description of the request

HttpRequest

fun HttpRequest(method: HttpMethod, url: <Error class: unknown class>, headers: Headers = Headers.Empty, body: HttpBody = HttpBody.Empty, trailingHeaders: DeferredHeaders = DeferredHeaders.Empty): HttpRequest

Create a new HttpRequest

Inherited functions

header

fun HttpRequestBuilder.header(name: String, value: String)

Add a single header. This will append to any existing headers with the same name.

headers

inline fun HttpRequestBuilder.headers(block: HeadersBuilder.() -> Unit)

Modify the headers inside the given block

immutableView

fun HttpRequestBuilder.immutableView(allowToBuilder: Boolean = false): HttpRequest

Create a read-only view of a builder. Often, we need a read-only view of a builder that may get modified. This would normally require a round trip invoking HttpRequestBuilder.build and then converting that back to a builder using HttpRequest.toBuilder. Instead, we can create an immutable view of a builder that is cheap to convert to a builder.

toBuilder

fun HttpRequest.toBuilder(): HttpRequestBuilder

Convert an HttpRequest back to an HttpRequestBuilder

url

fun HttpRequestBuilder.url(value: <Error class: unknown class>)

Set values from an existing Url instance

inline fun HttpRequestBuilder.url(block: <Error class: unknown class>.() -> Unit)

Modify the URL inside the block