http4k-connect-core/org.http4k.connect

Package-level declarations

Types

interface Action<R>

AutomarshalledPagedAction

abstract class AutomarshalledPagedAction<Token, ItemType : Any, PageType : Paged<Token, ItemType>, Self : AutomarshalledPagedAction<Token, ItemType, PageType, Self>>(toResult: (List<ItemType>, Token?) -> PageType, autoMarshalling: AutoMarshalling, kClass: KClass<PageType>) : PagedAction<Token, ItemType, PageType, Self> , LensExtractor<Response, Token?>

Superclass for paged actions where the response can be auto-marshalled

Http4kConnectAction

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Http4kConnectAction(val docs: String = "")

Marker attached to all actions to drive the client code generation.

Http4kConnectApiClient

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Http4kConnectApiClient

NonNullAutoMarshalledAction

abstract class NonNullAutoMarshalledAction<R : Any>(clazz: KClass<R>, autoMarshalling: AutoMarshalling) : Action<Result<R, RemoteFailure>>

NullableAutoMarshalledAction

abstract class NullableAutoMarshalledAction<R : Any>(clazz: KClass<R>, json: AutoMarshalling) : Action<Result<R?, RemoteFailure>>

interface Paged<out Token, out ItemType> : Iterable<ItemType>

Represents a Paged response

interface PagedAction<Token, ItemType, Rsp : Paged<Token, ItemType>, Self : PagedAction<Token, ItemType, Rsp, Self>> : Action<Result<Rsp, RemoteFailure>>

Superclass for all Paged actions

PlainTextAction

abstract class PlainTextAction : Action<Result<String, RemoteFailure>>

data class RemoteFailure(val method: Method, val uri: Uri, val status: Status, val message: String? = null)

abstract class Result4kAction<R, T : Action<R>>(action: T) : Action<Result<R, RemoteFailure>>

Transparent Action adapter from standard -> Result4k monad

abstract class ResultAction<R, T : Action<R>>(action: T) : Action<Result<R>>

Transparent Action adapter from standard -> Kotlin Result monad

Functions

fun <T : Any> StringBuilder.appendAll(items: Collection<T>, fn: (T) -> String): StringBuilder

asRemoteFailure

fun <R> Action<R>.asRemoteFailure(response: Response): RemoteFailure

inline fun <T : Any> kClass(): KClass<T>

fun <T> Result<T, RemoteFailure>.orThrow(): T

fun <Token, ItemType, Action : PagedAction<Token, ItemType, Rsp, Action>, Rsp : Paged<Token, ItemType>> paginated(fn: (Action) -> Result<Rsp, RemoteFailure>, action: Action): Sequence<Result<List<ItemType>, RemoteFailure>>

Paginate the response of the passed action