androidx.paging.rxjava2
Classes
| RxPagingSource |
Rx-based compatibility wrapper around PagingSource's suspending APIs. |
| RxRemoteMediator |
RxJava2 compatibility wrapper around RemoteMediator's suspending APIs. |
Extension functions summary
| For io.reactivex.Flowable | |
| Flowable<PagingData<T>> |
Flowable<PagingData<T>>.cachedIn(scope: CoroutineScope)Operator which caches a Flowable of PagingData within a CoroutineScope. |
| For io.reactivex.Observable | |
| Observable<PagingData<T>> |
Observable<PagingData<T>>.cachedIn(scope: CoroutineScope)Operator which caches an Observable of PagingData within a CoroutineScope. |
Extension properties summary
| For Pager | |
| Flowable<PagingData<Value>> |
A Flowable of PagingData, which mirrors the stream provided by Pager.flow, but exposes it as a Flowable. |
| Observable<PagingData<Value>> |
Pager<Key, Value>.observable()An Observable of PagingData, which mirrors the stream provided by Pager.flow, but exposes it as an Observable. |
Extension functions
cachedIn
fun <T : Any> Flowable<PagingData<T>>.cachedIn(scope: CoroutineScope): Flowable<PagingData<T>>
Operator which caches a Flowable of PagingData within a CoroutineScope.
cachedIn multicasts pages loaded and transformed by a PagingData, allowing multiple observers on the same instance of PagingData to receive the same events, avoiding redundant work, but comes at the cost of buffering those events in memory.
Calling cachedIn is required to allow calling submitData on the same instance of PagingData emitted by Pager or any of its transformed derivatives, as reloading data from scratch on the same generation of PagingData is an unsupported operation.
| Parameters | |
|---|---|
| scope: CoroutineScope | The CoroutineScope where the page cache will be kept alive. Typically this
would be a managed scope such as ViewModel.viewModelScope, which automatically cancels after
the PagingData stream is no longer needed. Otherwise, the provided CoroutineScope must be
manually cancelled to avoid memory leaks. |
cachedIn
fun <T : Any> Observable<PagingData<T>>.cachedIn(scope: CoroutineScope): Observable<PagingData<T>>
Operator which caches an Observable of PagingData within a CoroutineScope.
cachedIn multicasts pages loaded and transformed by a PagingData, allowing multiple observers on the same instance of PagingData to receive the same events, avoiding redundant work, but comes at the cost of buffering those events in memory.
Calling cachedIn is required to allow calling submitData on the same instance of PagingData emitted by Pager or any of its transformed derivatives, as reloading data from scratch on the same generation of PagingData is an unsupported operation.
| Parameters | |
|---|---|
| scope: CoroutineScope | The CoroutineScope where the page cache will be kept alive. Typically this
would be a managed scope such as ViewModel.viewModelScope, which automatically cancels after
the PagingData stream is no longer needed. Otherwise, the provided CoroutineScope must be
manually cancelled to avoid memory leaks. |
Extension properties
flowable
val <Key : Any, Value : Any> Pager<Key, Value>.flowable: Flowable<PagingData<Value>>
A Flowable of PagingData, which mirrors the stream provided by Pager.flow, but exposes it as a Flowable.
observable
val <Key : Any, Value : Any> Pager<Key, Value>.observable: Observable<PagingData<Value>>
An Observable of PagingData, which mirrors the stream provided by Pager.flow, but exposes it as an Observable.