From 1cd85e089d386aeefd33a70d62297cf6ec30d74c Mon Sep 17 00:00:00 2001 From: "Deployment Bot (from Travis CI)" Date: Sat, 4 Jan 2020 12:28:00 +0000 Subject: [PATCH] Deploy motorro/RxLceModel to github.com/motorro/RxLceModel.git:master --- .../-cache-then-net-lce-model/-init-.md | 2 +- .../-cache-then-net-lce-model/index.md | 4 +-- .../-cache-then-net-lce-model/state.md | 2 +- .../-lce-model/cache-then-net.md | 4 +-- .../-lce-model/index.md | 4 +-- .../-lce-model/state.md | 2 +- .../-lce-state/-content/-init-.md | 2 +- .../-lce-state/-content/index.md | 9 +++---- .../-lce-state/-content/params.md | 13 --------- .../-lce-state/-error/-init-.md | 2 +- .../-lce-state/-error/index.md | 9 +++---- .../-lce-state/-error/params.md | 13 --------- .../-lce-state/-loading/-init-.md | 2 +- .../-lce-state/-loading/index.md | 9 +++---- .../-lce-state/-loading/params.md | 13 --------- .../-lce-state/-terminated/-init-.md | 4 +-- .../-lce-state/-terminated/equals.md | 5 ++++ .../-lce-state/-terminated/hash-code.md | 5 ++++ .../-lce-state/-terminated/index.md | 18 ++++++++----- .../-lce-state/-terminated/params.md | 13 --------- .../-lce-state/index.md | 27 +++++++++---------- .../-lce-state/params.md | 8 ------ .../-lce-state/to-error.md | 2 +- .../-lce-state/to-loading.md | 2 +- .../-strategy-update-wrapper/index.md | 2 +- .../-update-wrapper/index.md | 2 +- .../-update-wrapper/state.md | 2 +- .../-updating-lce-model-wrapper/index.md | 2 +- .../-updating-lce-model/index.md | 2 +- docs/com.motorro.rxlcemodel.base/index.md | 4 +-- .../data-no-errors.md | 6 ++--- .../data-stop-on-empty-errors.md | 6 ++--- .../data-stop-on-errors.md | 6 ++--- .../io.reactivex.-observable/get-data.md | 4 +-- .../io.reactivex.-observable/index.md | 16 +++++------ .../stop-on-empty-errors.md | 6 ++--- .../stop-on-errors.md | 6 ++--- .../terminate-on-error.md | 6 ++--- .../io.reactivex.-observable/valid-data.md | 6 ++--- docs/com.motorro.rxlcemodel.base/map.md | 4 +-- docs/package-list | 16 +++++------ 41 files changed, 101 insertions(+), 169 deletions(-) delete mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-content/params.md delete mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-error/params.md delete mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-loading/params.md create mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/equals.md create mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/hash-code.md delete mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/params.md delete mode 100644 docs/com.motorro.rxlcemodel.base/-lce-state/params.md diff --git a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/-init-.md b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/-init-.md index 23b7d969..a9b4f69e 100644 --- a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/-init-.md +++ b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/-init-.md @@ -2,7 +2,7 @@ # <init> -`CacheThenNetLceModel(params: `[`PARAMS`](index.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>)` +`CacheThenNetLceModel(params: `[`PARAMS`](index.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>)` A [LceModel](../-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache diff --git a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/index.md b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/index.md index f662b995..b52b731b 100644 --- a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/index.md +++ b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/index.md @@ -26,7 +26,7 @@ Cache service *must* notify of its data changes! | Name | Summary | |---|---| -| [<init>](-init-.md) | `CacheThenNetLceModel(params: `[`PARAMS`](index.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>)`
A [LceModel](../-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns [com.gojuno.koptional.None](#). The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! | +| [<init>](-init-.md) | `CacheThenNetLceModel(params: `[`PARAMS`](index.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>)`
A [LceModel](../-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns [com.gojuno.koptional.None](#). The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! | ### Properties @@ -34,7 +34,7 @@ Cache service *must* notify of its data changes! |---|---| | [params](params.md) | `val params: `[`PARAMS`](index.md#PARAMS)
Params that identify data being loaded | | [refresh](refresh.md) | `val refresh: `[`Completable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Completable.html)
Requests a refresh of data. Data will be updated asynchronously | -| [state](state.md) | `val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>`
Model data. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | +| [state](state.md) | `val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>`
Model data. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | ### Extension Functions diff --git a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/state.md b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/state.md index 194f5126..a1ea6a30 100644 --- a/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/state.md +++ b/docs/com.motorro.rxlcemodel.base/-cache-then-net-lce-model/state.md @@ -2,7 +2,7 @@ # state -`val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>` +`val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>` Overrides [LceModel.state](../-lce-model/state.md) diff --git a/docs/com.motorro.rxlcemodel.base/-lce-model/cache-then-net.md b/docs/com.motorro.rxlcemodel.base/-lce-model/cache-then-net.md index 4b65b9de..4e06b372 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-model/cache-then-net.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-model/cache-then-net.md @@ -2,7 +2,7 @@ # cacheThenNet -`@JvmOverloads fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>> = Observable.just(Loading(null, false, params))): `[`LceModel`](index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>` +`@JvmOverloads fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`>> = Observable.just(Loading(null, false))): `[`LceModel`](index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>` Creates a model that returns cached data first, then refreshes if stall @@ -16,7 +16,7 @@ Creates a model that returns cached data first, then refreshes if stall `serviceSet` - Service-set to load data -`startWith` - Observable that emits at loading start. Defaults to [LceState.Loading](../-lce-state/-loading/index.md)`@JvmOverloads fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, net: `[`NetService`](../../com.motorro.rxlcemodel.base.service/-net-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, cache: `[`CacheService`](../../com.motorro.rxlcemodel.base.service/-cache-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>> = Observable.just(Loading(null, false, params))): `[`LceModel`](index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>` +`startWith` - Observable that emits at loading start. Defaults to [LceState.Loading](../-lce-state/-loading/index.md)`@JvmOverloads fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, net: `[`NetService`](../../com.motorro.rxlcemodel.base.service/-net-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, cache: `[`CacheService`](../../com.motorro.rxlcemodel.base.service/-cache-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`>> = Observable.just(Loading(null, false))): `[`LceModel`](index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>` Creates a model that returns cached data first, than refreshes if stall diff --git a/docs/com.motorro.rxlcemodel.base/-lce-model/index.md b/docs/com.motorro.rxlcemodel.base/-lce-model/index.md index 4844f7d5..ffe410a3 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-model/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-model/index.md @@ -18,13 +18,13 @@ A model interface to load data and transmit it to subscribers along with loading |---|---| | [params](params.md) | `abstract val params: `[`PARAMS`](index.md#PARAMS)
Params that identify data being loaded | | [refresh](refresh.md) | `abstract val refresh: `[`Completable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Completable.html)
Requests a refresh of data. Data will be updated asynchronously | -| [state](state.md) | `abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | +| [state](state.md) | `abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | ### Companion Object Functions | Name | Summary | |---|---| -| [cacheThenNet](cache-then-net.md) | `fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>> = Observable.just(Loading(null, false, params))): `[`LceModel`](./index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>`
Creates a model that returns cached data first, then refreshes if stall`fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, net: `[`NetService`](../../com.motorro.rxlcemodel.base.service/-net-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, cache: `[`CacheService`](../../com.motorro.rxlcemodel.base.service/-cache-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>> = Observable.just(Loading(null, false, params))): `[`LceModel`](./index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>`
Creates a model that returns cached data first, than refreshes if stall | +| [cacheThenNet](cache-then-net.md) | `fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, serviceSet: `[`ServiceSet`](../../com.motorro.rxlcemodel.base.service/-service-set/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`>> = Observable.just(Loading(null, false))): `[`LceModel`](./index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>`
Creates a model that returns cached data first, then refreshes if stall`fun cacheThenNet(params: `[`PARAMS`](cache-then-net.md#PARAMS)`, net: `[`NetService`](../../com.motorro.rxlcemodel.base.service/-net-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, cache: `[`CacheService`](../../com.motorro.rxlcemodel.base.service/-cache-service/index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>, startWith: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](cache-then-net.md#DATA)`>> = Observable.just(Loading(null, false))): `[`LceModel`](./index.md)`<`[`DATA`](cache-then-net.md#DATA)`, `[`PARAMS`](cache-then-net.md#PARAMS)`>`
Creates a model that returns cached data first, than refreshes if stall | ### Extension Functions diff --git a/docs/com.motorro.rxlcemodel.base/-lce-model/state.md b/docs/com.motorro.rxlcemodel.base/-lce-model/state.md index 0413e677..4b503a02 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-model/state.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-model/state.md @@ -2,7 +2,7 @@ # state -`abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>` +`abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>` Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/-init-.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-content/-init-.md index a6d9ef24..ba33f2f1 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/-init-.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-content/-init-.md @@ -2,7 +2,7 @@ # <init> -`Content(data: `[`DATA`](index.md#DATA)`, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`)` +`Content(data: `[`DATA`](index.md#DATA)`, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Data is loaded and content is displayed diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/index.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-content/index.md index 68d62607..ac5fab6e 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-content/index.md @@ -2,7 +2,7 @@ # Content -`data class Content : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`data class Content : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`>` Data is loaded and content is displayed @@ -10,7 +10,7 @@ Data is loaded and content is displayed | Name | Summary | |---|---| -| [<init>](-init-.md) | `Content(data: `[`DATA`](index.md#DATA)`, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`)`
Data is loaded and content is displayed | +| [<init>](-init-.md) | `Content(data: `[`DATA`](index.md#DATA)`, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
Data is loaded and content is displayed | ### Properties @@ -18,11 +18,10 @@ Data is loaded and content is displayed |---|---| | [data](data.md) | `val data: `[`DATA`](index.md#DATA)
State data | | [dataIsValid](data-is-valid.md) | `val dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | -| [params](params.md) | `val params: `[`PARAMS`](index.md#PARAMS)
Params used to load [data](data.md) | ### Inherited Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Error](../-error/index.md) state preserving data | -| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | +| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Error](../-error/index.md) state preserving data | +| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/params.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-content/params.md deleted file mode 100644 index 9032249c..00000000 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-content/params.md +++ /dev/null @@ -1,13 +0,0 @@ -[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Content](index.md) / [params](./params.md) - -# params - -`val params: `[`PARAMS`](index.md#PARAMS) - -Overrides [LceState.params](../params.md) - -Params used to load [data](data.md) - -### Property - -`params` - Params used to load [data](data.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/-init-.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-error/-init-.md index 98b3277a..1bb37611 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/-init-.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-error/-init-.md @@ -2,7 +2,7 @@ # <init> -`Error(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`, error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` +`Error(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` Data (or part of it) failed to load diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/index.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-error/index.md index 3dd2f5d4..fb988ad0 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-error/index.md @@ -2,7 +2,7 @@ # Error -`data class Error : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`data class Error : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`>` Data (or part of it) failed to load @@ -10,7 +10,7 @@ Data (or part of it) failed to load | Name | Summary | |---|---| -| [<init>](-init-.md) | `Error(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`, error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)`
Data (or part of it) failed to load | +| [<init>](-init-.md) | `Error(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)`
Data (or part of it) failed to load | ### Properties @@ -19,11 +19,10 @@ Data (or part of it) failed to load | [data](data.md) | `val data: `[`DATA`](index.md#DATA)`?`
State data | | [dataIsValid](data-is-valid.md) | `val dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | | [error](error.md) | `val error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
Data load error | -| [params](params.md) | `val params: `[`PARAMS`](index.md#PARAMS)
Params used to load [data](data.md) | ### Inherited Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](./index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Error](./index.md) state preserving data | -| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | +| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](./index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Error](./index.md) state preserving data | +| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/params.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-error/params.md deleted file mode 100644 index 73399c7c..00000000 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-error/params.md +++ /dev/null @@ -1,13 +0,0 @@ -[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Error](index.md) / [params](./params.md) - -# params - -`val params: `[`PARAMS`](index.md#PARAMS) - -Overrides [LceState.params](../params.md) - -Params used to load [data](data.md) - -### Property - -`params` - Params used to load [data](data.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/-init-.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/-init-.md index 2525f302..c662c911 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/-init-.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/-init-.md @@ -2,7 +2,7 @@ # <init> -`Loading(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`, type: `[`Type`](-type/index.md)` = Type.LOADING)` +`Loading(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, type: `[`Type`](-type/index.md)` = Type.LOADING)` View is loading diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/index.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/index.md index 36fe5901..27f096d3 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/index.md @@ -2,7 +2,7 @@ # Loading -`data class Loading : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`data class Loading : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`>` View is loading @@ -16,7 +16,7 @@ View is loading | Name | Summary | |---|---| -| [<init>](-init-.md) | `Loading(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, params: `[`PARAMS`](index.md#PARAMS)`, type: `[`Type`](-type/index.md)` = Type.LOADING)`
View is loading | +| [<init>](-init-.md) | `Loading(data: `[`DATA`](index.md#DATA)`?, dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, type: `[`Type`](-type/index.md)` = Type.LOADING)`
View is loading | ### Properties @@ -24,12 +24,11 @@ View is loading |---|---| | [data](data.md) | `val data: `[`DATA`](index.md#DATA)`?`
State data | | [dataIsValid](data-is-valid.md) | `val dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | -| [params](params.md) | `val params: `[`PARAMS`](index.md#PARAMS)
Params used to load [data](data.md) | | [type](type.md) | `val type: `[`Type`](-type/index.md)
Loading type | ### Inherited Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Error](../-error/index.md) state preserving data | -| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](-type/index.md)` = Loading.Type.LOADING): `[`Loading`](./index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Loading](./index.md) state preserving data | +| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Error](../-error/index.md) state preserving data | +| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](-type/index.md)` = Loading.Type.LOADING): `[`Loading`](./index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Loading](./index.md) state preserving data | diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/params.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/params.md deleted file mode 100644 index af53bc34..00000000 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-loading/params.md +++ /dev/null @@ -1,13 +0,0 @@ -[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Loading](index.md) / [params](./params.md) - -# params - -`val params: `[`PARAMS`](index.md#PARAMS) - -Overrides [LceState.params](../params.md) - -Params used to load [data](data.md) - -### Property - -`params` - Params used to load [data](data.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/-init-.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/-init-.md index 29064e48..d2f97cd7 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/-init-.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/-init-.md @@ -2,10 +2,10 @@ # <init> -`Terminated(params: `[`PARAMS`](index.md#PARAMS)`)` +`Terminated()` A special state that may be used to terminate state emission in cases we always need a latest state to proceed -For example we have a view that subscribes to [LceState](../index.md) for a resource identified with [PARAMS](index.md#PARAMS). +For example we have a view that subscribes to [LceState](../index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/equals.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/equals.md new file mode 100644 index 00000000..ed96b135 --- /dev/null +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/equals.md @@ -0,0 +1,5 @@ +[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Terminated](index.md) / [equals](./equals.md) + +# equals + +`fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/hash-code.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/hash-code.md new file mode 100644 index 00000000..c50b3252 --- /dev/null +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/hash-code.md @@ -0,0 +1,5 @@ +[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Terminated](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/index.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/index.md index b25b92ad..0900026b 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/index.md @@ -2,10 +2,10 @@ # Terminated -`data class Terminated : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`class Terminated : `[`LceState`](../index.md)`<`[`DATA`](index.md#DATA)`>` A special state that may be used to terminate state emission in cases we always need a latest state to proceed -For example we have a view that subscribes to [LceState](../index.md) for a resource identified with [PARAMS](index.md#PARAMS). +For example we have a view that subscribes to [LceState](../index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](./index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case @@ -18,7 +18,7 @@ logic. | Name | Summary | |---|---| -| [<init>](-init-.md) | `Terminated(params: `[`PARAMS`](index.md#PARAMS)`)`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](../index.md) for a resource identified with [PARAMS](index.md#PARAMS). Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](./index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | +| [<init>](-init-.md) | `Terminated()`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](../index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](./index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | ### Properties @@ -26,11 +26,17 @@ logic. |---|---| | [data](data.md) | `val data: `[`DATA`](index.md#DATA)`?`
State data | | [dataIsValid](data-is-valid.md) | `val dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | -| [params](params.md) | `val params: `[`PARAMS`](index.md#PARAMS)
Params used to load [data](data.md) | + +### Functions + +| Name | Summary | +|---|---| +| [equals](equals.md) | `fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hashCode](hash-code.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | ### Inherited Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Error](../-error/index.md) state preserving data | -| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`, `[`PARAMS`](../index.md#PARAMS)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | +| [toError](../to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](../-error/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Error](../-error/index.md) state preserving data | +| [toLoading](../to-loading.md) | `fun toLoading(type: `[`Type`](../-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](../-loading/index.md)`<`[`DATA`](../index.md#DATA)`>`
Transfers to [Loading](../-loading/index.md) state preserving data | diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/params.md b/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/params.md deleted file mode 100644 index e043e553..00000000 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/-terminated/params.md +++ /dev/null @@ -1,13 +0,0 @@ -[com.motorro.rxlcemodel.base](../../index.md) / [LceState](../index.md) / [Terminated](index.md) / [params](./params.md) - -# params - -`val params: `[`PARAMS`](index.md#PARAMS) - -Overrides [LceState.params](../params.md) - -Params used to load [data](data.md) - -### Property - -`params` - Params used to load [data](data.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/index.md b/docs/com.motorro.rxlcemodel.base/-lce-state/index.md index bf9b9596..e5d4854f 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/index.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/index.md @@ -2,7 +2,7 @@ # LceState -`sealed class LceState` +`sealed class LceState` State for "Loading-Content-Error" resource which retrieves [data](data.md) @@ -10,16 +10,14 @@ State for "Loading-Content-Error" resource which retrieves [data](data.md) `DATA` - Data Type of data being held -`PARAMS` - Params that identify data being loaded - ### Types | Name | Summary | |---|---| -| [Content](-content/index.md) | `data class Content : `[`LceState`](./index.md)`<`[`DATA`](-content/index.md#DATA)`, `[`PARAMS`](-content/index.md#PARAMS)`>`
Data is loaded and content is displayed | -| [Error](-error/index.md) | `data class Error : `[`LceState`](./index.md)`<`[`DATA`](-error/index.md#DATA)`, `[`PARAMS`](-error/index.md#PARAMS)`>`
Data (or part of it) failed to load | -| [Loading](-loading/index.md) | `data class Loading : `[`LceState`](./index.md)`<`[`DATA`](-loading/index.md#DATA)`, `[`PARAMS`](-loading/index.md#PARAMS)`>`
View is loading | -| [Terminated](-terminated/index.md) | `data class Terminated : `[`LceState`](./index.md)`<`[`DATA`](-terminated/index.md#DATA)`, `[`PARAMS`](-terminated/index.md#PARAMS)`>`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](./index.md) for a resource identified with [PARAMS](-terminated/index.md#PARAMS). Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | +| [Content](-content/index.md) | `data class Content : `[`LceState`](./index.md)`<`[`DATA`](-content/index.md#DATA)`>`
Data is loaded and content is displayed | +| [Error](-error/index.md) | `data class Error : `[`LceState`](./index.md)`<`[`DATA`](-error/index.md#DATA)`>`
Data (or part of it) failed to load | +| [Loading](-loading/index.md) | `data class Loading : `[`LceState`](./index.md)`<`[`DATA`](-loading/index.md#DATA)`>`
View is loading | +| [Terminated](-terminated/index.md) | `class Terminated : `[`LceState`](./index.md)`<`[`DATA`](-terminated/index.md#DATA)`>`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](./index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | ### Properties @@ -27,26 +25,25 @@ State for "Loading-Content-Error" resource which retrieves [data](data.md) |---|---| | [data](data.md) | `abstract val data: `[`DATA`](index.md#DATA)`?`
State data | | [dataIsValid](data-is-valid.md) | `abstract val dataIsValid: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | -| [params](params.md) | `abstract val params: `[`PARAMS`](index.md#PARAMS)
Params used to load state [data](data.md) | ### Functions | Name | Summary | |---|---| -| [toError](to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](-error/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>`
Transfers to [Error](-error/index.md) state preserving data | -| [toLoading](to-loading.md) | `fun toLoading(type: `[`Type`](-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](-loading/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>`
Transfers to [Loading](-loading/index.md) state preserving data | +| [toError](to-error.md) | `fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](-error/index.md)`<`[`DATA`](index.md#DATA)`>`
Transfers to [Error](-error/index.md) state preserving data | +| [toLoading](to-loading.md) | `fun toLoading(type: `[`Type`](-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](-loading/index.md)`<`[`DATA`](index.md#DATA)`>`
Transfers to [Loading](-loading/index.md) state preserving data | ### Extension Functions | Name | Summary | |---|---| -| [map](../map.md) | `fun `[`LceState`](./index.md)`<`[`DATA_1`](../map.md#DATA_1)`, `[`PARAMS`](../map.md#PARAMS)`>.map(mapper: (data: `[`DATA_1`](../map.md#DATA_1)`) -> `[`DATA_2`](../map.md#DATA_2)`): `[`LceState`](./index.md)`<`[`DATA_2`](../map.md#DATA_2)`, `[`PARAMS`](../map.md#PARAMS)`>`
Maps data in LceState | +| [map](../map.md) | `fun `[`LceState`](./index.md)`<`[`DATA_1`](../map.md#DATA_1)`>.map(mapper: (data: `[`DATA_1`](../map.md#DATA_1)`) -> `[`DATA_2`](../map.md#DATA_2)`): `[`LceState`](./index.md)`<`[`DATA_2`](../map.md#DATA_2)`>`
Maps data in LceState | ### Inheritors | Name | Summary | |---|---| -| [Content](-content/index.md) | `data class Content : `[`LceState`](./index.md)`<`[`DATA`](-content/index.md#DATA)`, `[`PARAMS`](-content/index.md#PARAMS)`>`
Data is loaded and content is displayed | -| [Error](-error/index.md) | `data class Error : `[`LceState`](./index.md)`<`[`DATA`](-error/index.md#DATA)`, `[`PARAMS`](-error/index.md#PARAMS)`>`
Data (or part of it) failed to load | -| [Loading](-loading/index.md) | `data class Loading : `[`LceState`](./index.md)`<`[`DATA`](-loading/index.md#DATA)`, `[`PARAMS`](-loading/index.md#PARAMS)`>`
View is loading | -| [Terminated](-terminated/index.md) | `data class Terminated : `[`LceState`](./index.md)`<`[`DATA`](-terminated/index.md#DATA)`, `[`PARAMS`](-terminated/index.md#PARAMS)`>`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](./index.md) for a resource identified with [PARAMS](-terminated/index.md#PARAMS). Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | +| [Content](-content/index.md) | `data class Content : `[`LceState`](./index.md)`<`[`DATA`](-content/index.md#DATA)`>`
Data is loaded and content is displayed | +| [Error](-error/index.md) | `data class Error : `[`LceState`](./index.md)`<`[`DATA`](-error/index.md#DATA)`>`
Data (or part of it) failed to load | +| [Loading](-loading/index.md) | `data class Loading : `[`LceState`](./index.md)`<`[`DATA`](-loading/index.md#DATA)`>`
View is loading | +| [Terminated](-terminated/index.md) | `class Terminated : `[`LceState`](./index.md)`<`[`DATA`](-terminated/index.md#DATA)`>`
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](./index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/params.md b/docs/com.motorro.rxlcemodel.base/-lce-state/params.md deleted file mode 100644 index 5f4d8c38..00000000 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/params.md +++ /dev/null @@ -1,8 +0,0 @@ -[com.motorro.rxlcemodel.base](../index.md) / [LceState](index.md) / [params](./params.md) - -# params - -`abstract val params: `[`PARAMS`](index.md#PARAMS) - -Params used to load state [data](data.md) - diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/to-error.md b/docs/com.motorro.rxlcemodel.base/-lce-state/to-error.md index ddc33919..9b058144 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/to-error.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/to-error.md @@ -2,7 +2,7 @@ # toError -`fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](-error/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`fun toError(error: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Error`](-error/index.md)`<`[`DATA`](index.md#DATA)`>` Transfers to [Error](-error/index.md) state preserving data diff --git a/docs/com.motorro.rxlcemodel.base/-lce-state/to-loading.md b/docs/com.motorro.rxlcemodel.base/-lce-state/to-loading.md index 16f9b908..34c5f3ac 100644 --- a/docs/com.motorro.rxlcemodel.base/-lce-state/to-loading.md +++ b/docs/com.motorro.rxlcemodel.base/-lce-state/to-loading.md @@ -2,7 +2,7 @@ # toLoading -`fun toLoading(type: `[`Type`](-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](-loading/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>` +`fun toLoading(type: `[`Type`](-loading/-type/index.md)` = Loading.Type.LOADING): `[`Loading`](-loading/index.md)`<`[`DATA`](index.md#DATA)`>` Transfers to [Loading](-loading/index.md) state preserving data diff --git a/docs/com.motorro.rxlcemodel.base/-strategy-update-wrapper/index.md b/docs/com.motorro.rxlcemodel.base/-strategy-update-wrapper/index.md index 3875807e..21d4639d 100644 --- a/docs/com.motorro.rxlcemodel.base/-strategy-update-wrapper/index.md +++ b/docs/com.motorro.rxlcemodel.base/-strategy-update-wrapper/index.md @@ -28,7 +28,7 @@ Implement methods to update properties using [doUpdate](../-update-wrapper/do-up | Name | Summary | |---|---| -| [state](../-update-wrapper/state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-update-wrapper/index.md#DATA)`, `[`PARAMS`](../-update-wrapper/index.md#PARAMS)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | +| [state](../-update-wrapper/state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-update-wrapper/index.md#DATA)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | ### Functions diff --git a/docs/com.motorro.rxlcemodel.base/-update-wrapper/index.md b/docs/com.motorro.rxlcemodel.base/-update-wrapper/index.md index 398dbf58..976e0ff1 100644 --- a/docs/com.motorro.rxlcemodel.base/-update-wrapper/index.md +++ b/docs/com.motorro.rxlcemodel.base/-update-wrapper/index.md @@ -28,7 +28,7 @@ Implement methods to update properties using [doUpdate](do-update.md) template | Name | Summary | |---|---| -| [state](state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | +| [state](state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | ### Functions diff --git a/docs/com.motorro.rxlcemodel.base/-update-wrapper/state.md b/docs/com.motorro.rxlcemodel.base/-update-wrapper/state.md index c479bfcd..4b3a4abe 100644 --- a/docs/com.motorro.rxlcemodel.base/-update-wrapper/state.md +++ b/docs/com.motorro.rxlcemodel.base/-update-wrapper/state.md @@ -2,7 +2,7 @@ # state -`open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`, `[`PARAMS`](index.md#PARAMS)`>>` +`open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](index.md#DATA)`>>` Overrides [LceModel.state](../-lce-model/state.md) diff --git a/docs/com.motorro.rxlcemodel.base/-updating-lce-model-wrapper/index.md b/docs/com.motorro.rxlcemodel.base/-updating-lce-model-wrapper/index.md index c6f43653..172e34f5 100644 --- a/docs/com.motorro.rxlcemodel.base/-updating-lce-model-wrapper/index.md +++ b/docs/com.motorro.rxlcemodel.base/-updating-lce-model-wrapper/index.md @@ -35,7 +35,7 @@ same cache as [upstream](#) uses for things to work correctly | Name | Summary | |---|---| -| [state](../-update-wrapper/state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-update-wrapper/index.md#DATA)`, `[`PARAMS`](../-update-wrapper/index.md#PARAMS)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | +| [state](../-update-wrapper/state.md) | `open val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-update-wrapper/index.md#DATA)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](#) emissions with update operation status. | ### Functions diff --git a/docs/com.motorro.rxlcemodel.base/-updating-lce-model/index.md b/docs/com.motorro.rxlcemodel.base/-updating-lce-model/index.md index d538f0a9..2e6b3b83 100644 --- a/docs/com.motorro.rxlcemodel.base/-updating-lce-model/index.md +++ b/docs/com.motorro.rxlcemodel.base/-updating-lce-model/index.md @@ -20,7 +20,7 @@ |---|---| | [params](../-lce-model/params.md) | `abstract val params: `[`PARAMS`](../-lce-model/index.md#PARAMS)
Params that identify data being loaded | | [refresh](../-lce-model/refresh.md) | `abstract val refresh: `[`Completable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Completable.html)
Requests a refresh of data. Data will be updated asynchronously | -| [state](../-lce-model/state.md) | `abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-lce-model/index.md#DATA)`, `[`PARAMS`](../-lce-model/index.md#PARAMS)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | +| [state](../-lce-model/state.md) | `abstract val state: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](../-lce-model/index.md#DATA)`>>`
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | ### Functions diff --git a/docs/com.motorro.rxlcemodel.base/index.md b/docs/com.motorro.rxlcemodel.base/index.md index 57ee26e0..3f1d812c 100644 --- a/docs/com.motorro.rxlcemodel.base/index.md +++ b/docs/com.motorro.rxlcemodel.base/index.md @@ -10,7 +10,7 @@ Basic LceModel classes |---|---| | [CacheThenNetLceModel](-cache-then-net-lce-model/index.md) | `class CacheThenNetLceModel : `[`LceModel`](-lce-model/index.md)`<`[`DATA`](-cache-then-net-lce-model/index.md#DATA)`, `[`PARAMS`](-cache-then-net-lce-model/index.md#PARAMS)`>`
A [LceModel](-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](-cache-then-net-lce-model/state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns [com.gojuno.koptional.None](#). The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! | | [LceModel](-lce-model/index.md) | `interface LceModel`
A model interface to load data and transmit it to subscribers along with loading operation state | -| [LceState](-lce-state/index.md) | `sealed class LceState`
State for "Loading-Content-Error" resource which retrieves [data](-lce-state/data.md) | +| [LceState](-lce-state/index.md) | `sealed class LceState`
State for "Loading-Content-Error" resource which retrieves [data](-lce-state/data.md) | | [StrategyUpdateWrapper](-strategy-update-wrapper/index.md) | `class StrategyUpdateWrapper : `[`UpdateWrapper`](-update-wrapper/index.md)`<`[`DATA`](-strategy-update-wrapper/index.md#DATA)`, `[`PARAMS`](-strategy-update-wrapper/index.md#PARAMS)`>`
Wraps [LceModel](-lce-model/index.md) and mixes in a data update state Use to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](-update-wrapper/do-update.md) template | | [UpdateWrapper](-update-wrapper/index.md) | `abstract class UpdateWrapper : `[`LceModel`](-lce-model/index.md)`<`[`DATA`](-update-wrapper/index.md#DATA)`, `[`PARAMS`](-update-wrapper/index.md#PARAMS)`>`
A base class that wraps [LceModel](-lce-model/index.md) and mixes in a data update state Extend to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](-update-wrapper/do-update.md) template | | [UpdatingLceModel](-updating-lce-model/index.md) | `interface UpdatingLceModel : `[`LceModel`](-lce-model/index.md)`<`[`DATA`](-updating-lce-model/index.md#DATA)`, `[`PARAMS`](-updating-lce-model/index.md#PARAMS)`>`
[LceModel](-lce-model/index.md) extension that can [update](-updating-lce-model/update.md) data | @@ -26,5 +26,5 @@ Basic LceModel classes | Name | Summary | |---|---| -| [map](map.md) | `fun `[`LceModel`](-lce-model/index.md)`<`[`DATA_1`](map.md#DATA_1)`, `[`PARAMS`](map.md#PARAMS)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceModel`](-lce-model/index.md)`<`[`DATA_2`](map.md#DATA_2)`, `[`PARAMS`](map.md#PARAMS)`>`
Creates a model wrapper that converts [DATA_1](map.md#DATA_1) to [DATA_2](map.md#DATA_2)`fun `[`LceState`](-lce-state/index.md)`<`[`DATA_1`](map.md#DATA_1)`, `[`PARAMS`](map.md#PARAMS)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceState`](-lce-state/index.md)`<`[`DATA_2`](map.md#DATA_2)`, `[`PARAMS`](map.md#PARAMS)`>`
Maps data in LceState | +| [map](map.md) | `fun `[`LceModel`](-lce-model/index.md)`<`[`DATA_1`](map.md#DATA_1)`, `[`PARAMS`](map.md#PARAMS)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceModel`](-lce-model/index.md)`<`[`DATA_2`](map.md#DATA_2)`, `[`PARAMS`](map.md#PARAMS)`>`
Creates a model wrapper that converts [DATA_1](map.md#DATA_1) to [DATA_2](map.md#DATA_2)`fun `[`LceState`](-lce-state/index.md)`<`[`DATA_1`](map.md#DATA_1)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceState`](-lce-state/index.md)`<`[`DATA_2`](map.md#DATA_2)`>`
Maps data in LceState | | [withUpdates](with-updates.md) | `fun `[`LceModel`](-lce-model/index.md)`<`[`DATA`](with-updates.md#DATA)`, `[`PARAMS`](with-updates.md#PARAMS)`>.withUpdates(serviceSet: `[`UpdatingServiceSet`](../com.motorro.rxlcemodel.base.service/-updating-service-set/index.md)`<`[`DATA`](with-updates.md#DATA)`, `[`UPDATE`](with-updates.md#UPDATE)`, `[`PARAMS`](with-updates.md#PARAMS)`>): `[`UpdatingLceModel`](-updating-lce-model/index.md)`<`[`DATA`](with-updates.md#DATA)`, `[`UPDATE`](with-updates.md#UPDATE)`, `[`PARAMS`](with-updates.md#PARAMS)`>`
Wraps an [LceModel](-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](-updating-lce-model/index.md) | diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md index 833df54e..df80c3af 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md @@ -2,13 +2,11 @@ # dataNoErrors -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-no-errors.md#DATA)`, `[`PARAMS`](data-no-errors.md#PARAMS)`>>.dataNoErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-no-errors.md#DATA)`>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-no-errors.md#DATA)`>>.dataNoErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-no-errors.md#DATA)`>` Model's data stream with state information dropped. No error state terminates stream ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md index 2235c55a..4e904ede 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md @@ -2,13 +2,11 @@ # dataStopOnEmptyErrors -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`, `[`PARAMS`](data-stop-on-empty-errors.md#PARAMS)`>>.dataStopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>>.dataStopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>` Model's data stream with state information dropped. Will terminate on errors with empty data ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md index f633d2a1..f1f8048f 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md @@ -2,13 +2,11 @@ # dataStopOnErrors -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-errors.md#DATA)`, `[`PARAMS`](data-stop-on-errors.md#PARAMS)`>>.dataStopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-errors.md#DATA)`>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-errors.md#DATA)`>>.dataStopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-errors.md#DATA)`>` Model's data stream with state information dropped. Will terminate on any error ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md index 0d934190..c9183a5b 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md @@ -2,7 +2,7 @@ # getData -`fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](get-data.md#DATA)`, `[`PARAMS`](get-data.md#PARAMS)`>>.getData(terminateOnError: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](get-data.md#DATA)`, `[`PARAMS`](get-data.md#PARAMS)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](get-data.md#DATA)`>` +`fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](get-data.md#DATA)`>>.getData(terminateOnError: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](get-data.md#DATA)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](get-data.md#DATA)`>` Returns model's data stream dropping state information @@ -10,7 +10,5 @@ Returns model's data stream dropping state information `DATA` - Source model data type -`PARAMS` - Params type - `terminateOnError` - A predicate to check error state. If predicate returns true, the stream is terminated with [LceState.Error.error](../-lce-state/-error/error.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/index.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/index.md index 658140e3..c904eb99 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/index.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/index.md @@ -4,11 +4,11 @@ | Name | Summary | |---|---| -| [dataNoErrors](data-no-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-no-errors.md#DATA)`, `[`PARAMS`](data-no-errors.md#PARAMS)`>>.dataNoErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-no-errors.md#DATA)`>`
Model's data stream with state information dropped. No error state terminates stream | -| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`, `[`PARAMS`](data-stop-on-empty-errors.md#PARAMS)`>>.dataStopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>`
Model's data stream with state information dropped. Will terminate on errors with empty data | -| [dataStopOnErrors](data-stop-on-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-errors.md#DATA)`, `[`PARAMS`](data-stop-on-errors.md#PARAMS)`>>.dataStopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-errors.md#DATA)`>`
Model's data stream with state information dropped. Will terminate on any error | -| [getData](get-data.md) | `fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](get-data.md#DATA)`, `[`PARAMS`](get-data.md#PARAMS)`>>.getData(terminateOnError: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](get-data.md#DATA)`, `[`PARAMS`](get-data.md#PARAMS)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](get-data.md#DATA)`>`
Returns model's data stream dropping state information | -| [stopOnEmptyErrors](stop-on-empty-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`, `[`PARAMS`](stop-on-empty-errors.md#PARAMS)`>>.stopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`, `[`PARAMS`](stop-on-empty-errors.md#PARAMS)`>>`
Model's state stream which terminates on errors with empty data | -| [stopOnErrors](stop-on-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`, `[`PARAMS`](stop-on-errors.md#PARAMS)`>>.stopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`, `[`PARAMS`](stop-on-errors.md#PARAMS)`>>`
Model's state stream which terminates on any error | -| [terminateOnError](terminate-on-error.md) | `fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>>.terminateOnError(predicate: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>>`
Terminates [LceModel.state](../-lce-model/state.md) stream if [predicate](terminate-on-error.md#com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)), kotlin.Boolean)))/predicate) returns true | -| [validData](valid-data.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](valid-data.md#DATA)`, `[`PARAMS`](valid-data.md#PARAMS)`>>.validData: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](valid-data.md#DATA)`>`
Model's valid data stream with state information dropped. Will terminate on any error | +| [dataNoErrors](data-no-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-no-errors.md#DATA)`>>.dataNoErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-no-errors.md#DATA)`>`
Model's data stream with state information dropped. No error state terminates stream | +| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>>.dataStopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-empty-errors.md#DATA)`>`
Model's data stream with state information dropped. Will terminate on errors with empty data | +| [dataStopOnErrors](data-stop-on-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](data-stop-on-errors.md#DATA)`>>.dataStopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](data-stop-on-errors.md#DATA)`>`
Model's data stream with state information dropped. Will terminate on any error | +| [getData](get-data.md) | `fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](get-data.md#DATA)`>>.getData(terminateOnError: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](get-data.md#DATA)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](get-data.md#DATA)`>`
Returns model's data stream dropping state information | +| [stopOnEmptyErrors](stop-on-empty-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`>>.stopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`>>`
Model's state stream which terminates on errors with empty data | +| [stopOnErrors](stop-on-errors.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`>>.stopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`>>`
Model's state stream which terminates on any error | +| [terminateOnError](terminate-on-error.md) | `fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>>.terminateOnError(predicate: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>>`
Terminates [LceModel.state](../-lce-model/state.md) stream if [predicate](terminate-on-error.md#com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA)), kotlin.Boolean)))/predicate) returns true | +| [validData](valid-data.md) | `val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](valid-data.md#DATA)`>>.validData: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](valid-data.md#DATA)`>`
Model's valid data stream with state information dropped. Will terminate on any error | diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md index 38f522a4..b434c6ab 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md @@ -2,12 +2,10 @@ # stopOnEmptyErrors -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`, `[`PARAMS`](stop-on-empty-errors.md#PARAMS)`>>.stopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`, `[`PARAMS`](stop-on-empty-errors.md#PARAMS)`>>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`>>.stopOnEmptyErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-empty-errors.md#DATA)`>>` Model's state stream which terminates on errors with empty data ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md index 31876664..7e089e68 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md @@ -2,12 +2,10 @@ # stopOnErrors -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`, `[`PARAMS`](stop-on-errors.md#PARAMS)`>>.stopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`, `[`PARAMS`](stop-on-errors.md#PARAMS)`>>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`>>.stopOnErrors: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](stop-on-errors.md#DATA)`>>` Model's state stream which terminates on any error ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md index e5f0fbd9..0597a50c 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md @@ -2,15 +2,13 @@ # terminateOnError -`fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>>.terminateOnError(predicate: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`, `[`PARAMS`](terminate-on-error.md#PARAMS)`>>` +`fun `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>>.terminateOnError(predicate: (`[`Error`](../-lce-state/-error/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](terminate-on-error.md#DATA)`>>` -Terminates [LceModel.state](../-lce-model/state.md) stream if [predicate](terminate-on-error.md#com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)), kotlin.Boolean)))/predicate) returns true +Terminates [LceModel.state](../-lce-model/state.md) stream if [predicate](terminate-on-error.md#com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA)), kotlin.Boolean)))/predicate) returns true ### Parameters `DATA` - Source model data type -`PARAMS` - Params type - `predicate` - A predicate to check error state. If predicate returns true, the stream is terminated with [LceState.Error.error](../-lce-state/-error/error.md) \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md index 7eab14d8..a57091da 100644 --- a/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md +++ b/docs/com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md @@ -2,13 +2,11 @@ # validData -`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](valid-data.md#DATA)`, `[`PARAMS`](valid-data.md#PARAMS)`>>.validData: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](valid-data.md#DATA)`>` +`val `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`LceState`](../-lce-state/index.md)`<`[`DATA`](valid-data.md#DATA)`>>.validData: `[`Observable`](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Observable.html)`<`[`DATA`](valid-data.md#DATA)`>` Model's valid data stream with state information dropped. Will terminate on any error ### Parameters -`DATA` - Source model data type - -`PARAMS` - Params type \ No newline at end of file +`DATA` - Source model data type \ No newline at end of file diff --git a/docs/com.motorro.rxlcemodel.base/map.md b/docs/com.motorro.rxlcemodel.base/map.md index 6a3826b5..d016c998 100644 --- a/docs/com.motorro.rxlcemodel.base/map.md +++ b/docs/com.motorro.rxlcemodel.base/map.md @@ -12,9 +12,7 @@ Creates a model wrapper that converts [DATA_1](map.md#DATA_1) to [DATA_2](map.md `DATA_2` - Resulting model data type -`PARAMS` - Params type - -`mapper` - Data mapper`inline fun `[`LceState`](-lce-state/index.md)`<`[`DATA_1`](map.md#DATA_1)`, `[`PARAMS`](map.md#PARAMS)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceState`](-lce-state/index.md)`<`[`DATA_2`](map.md#DATA_2)`, `[`PARAMS`](map.md#PARAMS)`>` +`mapper` - Data mapper`inline fun `[`LceState`](-lce-state/index.md)`<`[`DATA_1`](map.md#DATA_1)`>.map(mapper: (data: `[`DATA_1`](map.md#DATA_1)`) -> `[`DATA_2`](map.md#DATA_2)`): `[`LceState`](-lce-state/index.md)`<`[`DATA_2`](map.md#DATA_2)`>` Maps data in LceState diff --git a/docs/package-list b/docs/package-list index 8fd8215e..fbddfe70 100644 --- a/docs/package-list +++ b/docs/package-list @@ -1,13 +1,13 @@ $dokka.format:gfm $dokka.linkExtension:md -$dokka.location:com.motorro.rxlcemodel.base$dataNoErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataNoErrors.DATA, com.motorro.rxlcemodel.base.dataNoErrors.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md -$dokka.location:com.motorro.rxlcemodel.base$dataStopOnEmptyErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataStopOnEmptyErrors.DATA, com.motorro.rxlcemodel.base.dataStopOnEmptyErrors.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md -$dokka.location:com.motorro.rxlcemodel.base$dataStopOnErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataStopOnErrors.DATA, com.motorro.rxlcemodel.base.dataStopOnErrors.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md -$dokka.location:com.motorro.rxlcemodel.base$getData(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.getData.DATA, com.motorro.rxlcemodel.base.getData.PARAMS)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.getData.DATA, com.motorro.rxlcemodel.base.getData.PARAMS)), kotlin.Boolean)))com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md -$dokka.location:com.motorro.rxlcemodel.base$stopOnEmptyErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.stopOnEmptyErrors.DATA, com.motorro.rxlcemodel.base.stopOnEmptyErrors.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md -$dokka.location:com.motorro.rxlcemodel.base$stopOnErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.stopOnErrors.DATA, com.motorro.rxlcemodel.base.stopOnErrors.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md -$dokka.location:com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA, com.motorro.rxlcemodel.base.terminateOnError.PARAMS)), kotlin.Boolean)))com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md -$dokka.location:com.motorro.rxlcemodel.base$validData#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.validData.DATA, com.motorro.rxlcemodel.base.validData.PARAMS))))com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md +$dokka.location:com.motorro.rxlcemodel.base$dataNoErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataNoErrors.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-no-errors.md +$dokka.location:com.motorro.rxlcemodel.base$dataStopOnEmptyErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataStopOnEmptyErrors.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-empty-errors.md +$dokka.location:com.motorro.rxlcemodel.base$dataStopOnErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.dataStopOnErrors.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/data-stop-on-errors.md +$dokka.location:com.motorro.rxlcemodel.base$getData(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.getData.DATA)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.getData.DATA)), kotlin.Boolean)))com.motorro.rxlcemodel.base/io.reactivex.-observable/get-data.md +$dokka.location:com.motorro.rxlcemodel.base$stopOnEmptyErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.stopOnEmptyErrors.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-empty-errors.md +$dokka.location:com.motorro.rxlcemodel.base$stopOnErrors#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.stopOnErrors.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/stop-on-errors.md +$dokka.location:com.motorro.rxlcemodel.base$terminateOnError(io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.terminateOnError.DATA)))), kotlin.Function1((com.motorro.rxlcemodel.base.LceState.Error((com.motorro.rxlcemodel.base.terminateOnError.DATA)), kotlin.Boolean)))com.motorro.rxlcemodel.base/io.reactivex.-observable/terminate-on-error.md +$dokka.location:com.motorro.rxlcemodel.base$validData#io.reactivex.Observable((com.motorro.rxlcemodel.base.LceState((com.motorro.rxlcemodel.base.validData.DATA))))com.motorro.rxlcemodel.base/io.reactivex.-observable/valid-data.md com.motorro.rxlcemodel.base com.motorro.rxlcemodel.base.entity com.motorro.rxlcemodel.base.service