An object that intercepts requests before being sent and responses before being returned. The intercept function is a suspending function, meaning it is invoked as a coroutine. The coroutine shares the kotlin.coroutines.CoroutineContext used when the HTTP call is first initiated. Typically, this means that all interceptors, along with the HTTP call, are invoked within the same CoroutineScope, and thus typically the same parent kotlinx.coroutines.Job.

InterceptorsSpec

@Spec

interface InterceptorsSpec

A spec for adding interceptors to a client.

JavadocPlaceholder

open class JavadocPlaceholder

Placeholder to generate skeletal Javadoc for this Kotlin project.

KotlinAdapter

abstract class KotlinAdapter : AbstractBodyAdapter

A BodyAdapter that uses the serialization package for encoding or decoding Kotlin objects using any format represented by SerialFormat. The given SerialFormat is expected to be a StringFormat or a BinaryFormat, with a preference for the former if both.

MultipartBody

typealias MultipartBody = MultipartBodyPublisher

MultipartBodyPart

typealias MultipartBodyPart = MultipartBodyPublisher.Part

MultipartBodySpec

@Spec

interface MultipartBodySpec : PairCreationDisablingSpec

A spec for configuring a MultipartBody.

PairCreationDisablingSpec

@Spec

interface PairCreationDisablingSpec

A Spec in the context of which Kotlin's kotlin.to is disabled to avoid conflicts with similarly named spec-defined functions.

PushPromiseHandler

typealias PushPromiseHandler<T> = <Error class: unknown class><T>

Redirect

typealias Redirect = <Error class: unknown class>

Request

typealias Request = <Error class: unknown class>

RequestBodySpec

@Spec

interface RequestBodySpec

A spec for configuring a Request's body assuming its method has been set.

RequestMethodSpec

@Spec

interface RequestMethodSpec

A spec for configuring a Request's method and body.

RequestSpec

@Spec

interface RequestSpec : BaseRequestSpec, RequestMethodSpec

A spec for configuring a Request.

RequestWithKnownMethodSpec

@Spec

interface RequestWithKnownMethodSpec : BaseRequestSpec, RequestBodySpec

A spec for configuring a Request whose method has been set

Response

typealias Response<T> = <Error class: unknown class><T>

ResponseInfo

typealias ResponseInfo = <Error class: unknown class>

Spec

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Spec

Marks a type as a specification for configuring some object or property, typically by invoking a user-provided block with the spec as its receiver.

StringNameMultiStringValueSpec

@Spec

interface StringNameMultiStringValueSpec : PairCreationDisablingSpec

A Spec for configuring map-like properties with string keys and multi string values.

TagsSpec

@Spec

class TagsSpec(builder: TaggableRequest.Builder)

A spec for configuring request tags.

Functions

AdapterCodec

fun AdapterCodec(block: AdapterCodecSpec.() -> Unit): AdapterCodec

Creates a new com.github.mizosoft.methanol.AdapterCodec as configured by the given spec block.

body

inline fun <T> RequestBodySpec.body(payload: T, mediaType: MediaType)

Cache

fun Cache(block: CacheSpec.() -> Unit): HttpCache

Creates a new com.github.mizosoft.methanol.kotlin.Cache as configured by the given spec block.

CacheChain

fun CacheChain(block: CacheChainSpec.() -> Unit): List<Cache>

Creates a new com.github.mizosoft.methanol.kotlin.CacheChain as configured by the given spec block.

CacheControl

fun CacheControl(block: CacheControlSpec.() -> Unit): CacheControl

Creates a new CacheControl as configured by the given spec block.

Client

fun Client(block: ClientSpec.() -> Unit): Methanol

Creates a new Client as configured by the given spec block.

fun CacheChain.close()

Closes all caches in this chain.

closeable

fun CacheChain.closeable(): AutoCloseable

Returns an AutoCloseable that closes all caches in this chain when invoked.

delete

inline suspend fun <T> Client.delete(uri: String, noinline block: BaseRequestSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a DELETE request to the given URI, mapping the response body into T. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.delete(uri: String, bodyHandler: <Error class: unknown class><T>, block: BaseRequestSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a DELETE request to the given URI, mapping the response body with the given BodyHandler. A spec block can be optionally passed to customize the request.

fetch

inline suspend fun <T> Client.fetch(request: <Error class: unknown class>): <Error class: unknown class><T>

Fetches the response to sending the given request, mapping the response body into T.

inline suspend fun <T> Client.fetch(uri: String, noinline block: RequestSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a request to the given URI, mapping the response body into T. The request has a GET method by default. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.fetch(uri: String, bodyHandler: <Error class: unknown class><T>, block: RequestSpec.() -> Unit = {}): <Error class: unknown class><T>

Fetches the response sending a request to the given URI, mapping the response body with the given BodyHandler. The request has a GET method by default. A spec block can be optionally passed to customize the request.

FormBody

fun FormBody(block: FormBodySpec.() -> Unit): FormBodyPublisher

Creates a new FormBody as configured by the given spec block.

get

operator fun <Error class: unknown class>.get(name: String): List<String>

Returns all header values associated with the given name.

inline suspend fun <T> Client.get(uri: String, noinline block: BaseRequestSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a GET request to the given URI, mapping the response body into T. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.get(uri: String, bodyHandler: <Error class: unknown class><T>, block: BaseRequestSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a GET request to the given URI, mapping the response body with the given BodyHandler. A spec block can be optionally passed to customize the request.

handlerOf

inline fun <T> AdapterCodec.handlerOf(hints: BodyAdapter.Hints = Hints.empty()): <Error class: unknown class><T>

Returns a BodyHandler for the given type.

Headers

fun Headers(block: HeadersSpec.() -> Unit): <Error class: unknown class>

Creates a new Headers as configured by the given spec block.

fun Headers(headers: <Error class: unknown class>, block: HeadersSpec.() -> Unit): <Error class: unknown class>

Creates a copy of the given headers after configuring with the given spec block.

isClientError

fun <Error class: unknown class><T>.isClientError(): <Error class: unknown class>

Returns whether this response is 4xx client error.

isInformational

fun <Error class: unknown class><T>.isInformational(): <Error class: unknown class>

Returns whether this response is 1xx informational.

isRedirection

fun <Error class: unknown class><T>.isRedirection(): <Error class: unknown class>

Returns whether this response is 3xx redirection.

isServerError

fun <Error class: unknown class><T>.isServerError(): <Error class: unknown class>

Returns whether this response is 5xx server error.

isSuccessful

fun <Error class: unknown class><T>.isSuccessful(): <Error class: unknown class>

Returns whether this response is 2xx successful.

MultipartBody

fun MultipartBody(block: MultipartBodySpec.() -> Unit): MultipartBodyPublisher

Creates a new MultipartBody as configured by the given spec block.

MultipartBodyPart

fun MultipartBodyPart(bodyPublisher: <Error class: unknown class>, block: HeadersSpec.() -> Unit): MultipartBodyPart

Creates a new MultipartBodyPart as configured by the given spec block.

patch

inline suspend fun <T> Client.patch(uri: String, noinline block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a PATCH request to the given URI, mapping the response body into T. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.patch(uri: String, bodyHandler: <Error class: unknown class><T>, block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a PATCH request to the given URI, mapping the response body with the given BodyHandler. A spec block can be optionally passed to customize the request.

post

inline suspend fun <T> Client.post(uri: String, noinline block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a POST request to the given URI, mapping the response body into T. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.post(uri: String, bodyHandler: <Error class: unknown class><T>, block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a POST request to the given URI, mapping the response body with the given BodyHandler. A spec block can be optionally passed to customize the request.

put

inline suspend fun <T> Client.put(uri: String, noinline block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a PUT request to the given URI, mapping the response body into T. A spec block can be optionally passed to customize the request.

suspend fun <T> Client.put(uri: String, bodyHandler: <Error class: unknown class><T>, block: RequestWithKnownMethodSpec.() -> Unit = {}): <Error class: unknown class>

Fetches the response to sending a PUT request to the given URI, mapping the response body with the given BodyHandler. A spec block can be optionally passed to customize the request.

Request

fun Request(block: RequestSpec.() -> Unit): TaggableRequest

Creates a new Request as configured by the given spec block.

fun Request(request: <Error class: unknown class>, block: RequestSpec.() -> Unit): TaggableRequest

Creates a copy of the given request after configuring with the given spec block.

subscriberOf

inline fun <T> AdapterCodec.subscriberOf(hints: BodyAdapter.Hints = Hints.empty()): <Error class: unknown class><T>

Returns a BodySubscriber for the given type and Hints.

tag

inline fun <T : Any> <Error class: unknown class>.tag(): T?

Returns the tag associated with the given type if this request is a TaggableRequest and it has such a tag, or {@code null} otherwise.

inline suspend fun <T> ResponsePayload.to(): T

Converts this response payload into T.

toCacheControl

fun String.toCacheControl(): CacheControl

Parses the given string into a CacheControl instance as specified by the Cache-Control header.

fun List<String>.toCacheControl(): CacheControl

Parses the given strings into a CacheControl instance as specified by the Cache-Control header.

toHttpString

fun <Error class: unknown class>.toHttpString(valueToString: (String, String) -> String? = { name, value -> value }): <Error class: unknown class>

Returns a string representation for this Headers that is similar to how it would appear in an HTTP/1.1 response. valueToString can be used to control how header values appear, or whether they appear at all, in the returned string. You can use this to hide/exclude sensitive headers.

toMediaType

fun String.toMediaType(): MediaType

Parses the given string into a MediaType.

toTaggableRequest

fun <Error class: unknown class>.toTaggableRequest(): TaggableRequest

Returns this request if it is a TaggableRequest, or a TaggableRequest copy with no tags otherwise.

TypeRef

inline fun <T> TypeRef(): TypeRef<T>

Captures T within a TypeRef.

with

suspend fun <T> ResponsePayload.with(bodyHandler: <Error class: unknown class><T>): T

Converts this payload to T using the given body handler.

withMediaType

fun <Error class: unknown class>.withMediaType(mediaType: MediaType): MimeBodyPublisher

Associated the given media type with this BodyPublisher through a MimeBodyPublisher. This allows the Client to automatically add a corresponding Content-Type header.