soil-query-compose-runtime/soil.query.compose.runtime/Await

Await

inline fun <T> ~~Await~~(state: DataModel<T>, key: Any? = null, host: AwaitHost = LocalAwaitHost.current, errorPredicate: (DataModel<*>) -> Boolean = { it.reply.isNone }, errorFallback: @Composable CatchScope.(err: Throwable) -> Unit = { Throw(error = it) }, crossinline content: @Composable (data: T) -> Unit)

Deprecated

This implementation is deprecated. Please use the new implementation from soil-reacty module instead.

Replace with

import soil.plant.compose.reacty.Await

Await(state, key, host, errorPredicate, errorFallback, content)

Await for a DataModel to be fulfilled.

The content will be displayed when the query is fulfilled. The await will be managed by the AwaitHost.

Parameters

Type of data to retrieve.

state

The DataModel to await.

key

The key to identify the await.

host

The AwaitHost to manage the await. By default, it uses the LocalAwaitHost.

errorPredicate

A function to filter the error. By default, it filters the error when the query is rejected.

errorFallback

The content to display when the query is rejected. By default, it throws the error.

content

The content to display when the query is fulfilled.

@Composable

inline fun <T1, T2> ~~Await~~(state1: DataModel<T1>, state2: DataModel<T2>, key: Any? = null, host: AwaitHost = LocalAwaitHost.current, errorPredicate: (DataModel<*>) -> Boolean = { it.reply.isNone }, errorFallback: @Composable CatchScope.(err: Throwable) -> Unit = { Throw(error = it) }, crossinline content: @Composable (data1: T1, data2: T2) -> Unit)

Deprecated

This implementation is deprecated. Please use the new implementation from soil-reacty module instead.

Replace with

import soil.plant.compose.reacty.Await

Await(state1, state2, key, host, errorPredicate, errorFallback, content)

Await for two DataModel to be fulfilled.

The content will be displayed when the queries are fulfilled. The await will be managed by the AwaitHost.

Parameters

Type of data to retrieve.

state1

The first DataModel to await.

state2

The second DataModel to await.

key

The key to identify the await.

host

The AwaitHost to manage the await. By default, it uses the LocalAwaitHost.

errorPredicate

A function to filter the error. By default, it filters the error when the query is rejected.

errorFallback

The content to display when the query is rejected. By default, it throws the error.

content

The content to display when the queries are fulfilled.

@Composable

inline fun <T1, T2, T3> ~~Await~~(state1: DataModel<T1>, state2: DataModel<T2>, state3: DataModel<T3>, key: Any? = null, host: AwaitHost = LocalAwaitHost.current, errorPredicate: (DataModel<*>) -> Boolean = { it.reply.isNone }, errorFallback: @Composable CatchScope.(err: Throwable) -> Unit = { Throw(error = it) }, crossinline content: @Composable (data1: T1, data2: T2, data3: T3) -> Unit)

Deprecated

This implementation is deprecated. Please use the new implementation from soil-reacty module instead.

Replace with

import soil.plant.compose.reacty.Await

Await(state1, state2, state3, key, host, errorPredicate, errorFallback, content)

Await for three DataModel to be fulfilled.

The content will be displayed when the queries are fulfilled. The await will be managed by the AwaitHost.

Parameters

Type of data to retrieve.

state1

The first DataModel to await.

state2

The second DataModel to await.

state3

The third DataModel to await.

key

The key to identify the await.

host

The AwaitHost to manage the await. By default, it uses the LocalAwaitHost.

errorPredicate

A function to filter the error. By default, it filters the error when the query is rejected.

errorFallback

The content to display when the query is rejected. By default, it throws the error.

content

The content to display when the queries are fulfilled.