com.daftmobile.redukt.data

interface DataSource<in Request, out Response>

Any asynchronous source of data that provides Response on a call with a Request.

data class DataSourceAction<Request, Response>(val key: PureDataSourceKey<DataSource<Request, Response>>, val payload: DataSourcePayload<Request, Response>) : Action

An action associated with a DataSource identified by a given key. It represents an event that is described by a given payload.

DataSourceCall

data class DataSourceCall<Request, Response>(val key: PureDataSourceKey<DataSource<Request, Response>>, val request: Request) : ForegroundJobAction

An action that triggers a DataSource (identified by a given key) call with a given request in a foreground coroutine.

DataSourceKey

typealias DataSourceKey<Request, Response> = PureDataSourceKey<DataSource<Request, Response>>

DataSourcePayload

interface DataSourcePayload<Request, Response>

A payload for a DataSourceAction.

DataSourceResolver

interface DataSourceResolver : DispatchClosure.Element

Provides DataSources associated with PureDataSourceKeys.

DataSourceResultPayload

data class DataSourceResultPayload<Request, Response>(val request: Request, val result: Result<Response>)

Special type of payload that contains a kotlin.Result. It's not associated with DataSourceAction and it's only a util.

MissingDataSourceException

class MissingDataSourceException(key: PureDataSourceKey<*>) : Exception

PayloadReducer

typealias PayloadReducer<State, Payload> = (state: State, payload: Payload) -> State

PureDataSourceKey

interface PureDataSourceKey<out T : DataSource<*, *>>

Identifies a DataSource of type T.

TypeSafeResolverConfigMarker

@DslMarker

annotation class TypeSafeResolverConfigMarker

TypeSafeResolverConfigScope

interface TypeSafeResolverConfigScope

The scope for configuring DataSourceResolver with a type-safe DSL.

adaptRequest

fun <Request, OriginRequest, Response> DataSource<OriginRequest, Response>.adaptRequest(transform: suspend (Request) -> OriginRequest): DataSource<Request, Response>

Adapts a DataSource with transform to accept a Request instead of a OriginRequest.

adaptResponse

fun <Request, OriginResponse, Response> DataSource<Request, OriginResponse>.adaptResponse(transform: suspend (OriginResponse) -> Response): DataSource<Request, Response>

Adapts a DataSource with transform to return a Response instead of a OriginResponse.

asDataSourceAction

inline fun <Request, Response, T : DataSourceAction<Request, Response>> Action?.asDataSourceAction(key: PureDataSourceKey<DataSource<Request, Response>>): T?

Returns this as T if it is an instance of DataSourceAction associated with given key.

asOf

inline fun <Request, Response, T : DataSourceAction<Request, Response>> DataSourceAction<*, *>?.asOf(key: PureDataSourceKey<DataSource<Request, Response>>): T?

Returns this as T if it is an instance of DataSourceAction associated with given key.

call

suspend fun <Request, Response> DataSourceResolver.call(key: PureDataSourceKey<DataSource<Request, Response>>, request: Request): Response

Resolves a DataSource identified by a given key and calls with a given request.

callDataSource

suspend fun <Request, Response> DispatchScope<*>.callDataSource(key: PureDataSourceKey<DataSource<Request, Response>>, request: Request): Response

Calls a DataSource resolved with a DataSourceResolver from a DispatchScope.closure.

createDataSourceReducer

inline fun <Request, Response, State> createDataSourceReducer(key: PureDataSourceKey<DataSource<Request, Response>>, crossinline onStart: PayloadReducer<State, DataSourcePayload.Started<Request, Response>> = { s, _ -> s }, noinline onResult: PayloadReducer<State, DataSourceResultPayload<Request, Response>> = { s, _ -> s }, crossinline onElse: Reducer<State> = { s, _ -> s }): Reducer<State>

inline fun <Request, Response, State> createDataSourceReducer(key: PureDataSourceKey<DataSource<Request, Response>>, crossinline onStart: PayloadReducer<State, DataSourcePayload.Started<Request, Response>> = { s, _ -> s }, crossinline onSuccess: PayloadReducer<State, DataSourcePayload.Success<Request, Response>> = { s, _ -> s }, crossinline onFailure: PayloadReducer<State, DataSourcePayload.Failure<Request, Response>> = { s, _ -> s }, crossinline onElse: Reducer<State> = { s, _ -> s }): Reducer<State>

Creates a Reducer that:

DataSource

inline fun <Request, Response> DataSource(crossinline block: suspend (Request) -> Response): DataSource<Request, Response>

Creates a DataSource with given block invoked on each DataSource.call.

DataSourceResolver

fun DataSourceResolver(config: TypeSafeResolverConfigScope.() -> Unit): DataSourceResolver

Creates a DataSourceResolver with a config with type-safe DSL.

failureAction

fun <Request, Response> PureDataSourceKey<DataSource<Request, Response>>.failureAction(request: Request, error: Throwable): DataSourceAction<Request, Response>

startAction

fun <Request, Response> PureDataSourceKey<DataSource<Request, Response>>.startAction(request: Request): DataSourceAction<Request, Response>

successAction

fun <Request, Response> PureDataSourceKey<DataSource<Request, Response>>.successAction(request: Request, response: Response): DataSourceAction<Request, Response>

dataSourceMiddleware

val dataSourceMiddleware: Middleware<*>

Consumes DataSourceCall and launches a DataSource call in a foreground coroutine.

dataSourceResolver

val DispatchScope<*>.dataSourceResolver: DataSourceResolver

Returns DataSourceResolver instance associated with a store. It depends on DataSourceResolver element injected into the closure.

Package-level declarations

Types

Functions

Properties