Capillary/io.circul.capillary

Package-level declarations

Types

Factory

typealias Factory<T> = () -> T

A factory function that creates an instance of type T.

FactoryProvider

open class FactoryProvider<T>(factory: Factory<T>) : Provider<T>

A provider of instances of type T that are created by the given factory.

Port

interface Port<REQ : PortRequest, RES : PortResponse>

PortRequest

interface PortRequest

Base interface for all port requests. Implementing classes should ideally be sealed classes or sealed interfaces to represent a limited set of valid requests.

PortResponse

interface PortResponse

Base interface for all port responses. Implementing classes should ideally be sealed classes or sealed interfaces to represent a limited set of valid responses.

Provider

interface Provider<T>

A provider of instances of type T.

ResponseReceiver

class ResponseReceiver<RES : PortResponse>(val response: RES)

A receiver for a PortResponse that allows for pattern matching on the response type.

SingletonProvider

open class SingletonProvider<T>(factory: Factory<T>) : Provider<T>

A provider of instances of type T that are created by the given Factory and cached.

Functions

then

infix fun <RES : PortResponse> RES.then(block: ResponseReceiver<RES>.() -> Unit)

Infix function to chain a response receiver to a response.

via

infix fun <REQ : PortRequest, RES : PortResponse> REQ.via(port: Port<REQ, RES>): RES

Infix function to chain a request to a port, processing it and returning a response.