autodispose/autodispose2

Package-level declarations

Core implementation.

Types

Link copied to clipboard
class AutoDispose
Factories for autodispose converters that can be used with RxJava types' corresponding as(...) methods to transform them into auto-disposing streams.
Link copied to clipboard
interface AutoDisposeContext

A context intended for use as AutoDisposeContext.() -> Unit function body parameters where zero-arg autoDispose functions can be called. This should be backed by an underlying Completable or ScopeProvider.

Link copied to clipboard
interface AutoDisposeConverter<@NonNull T> : FlowableConverter<T, R> , ParallelFlowableConverter<T, R> , ObservableConverter<T, R> , MaybeConverter<T, R> , SingleConverter<T, R> , CompletableConverter<R>
A custom converter that implements all the RxJava types converters, for use with the as() operator.
Link copied to clipboard
class AutoDisposePlugins
Utility class to inject handlers to certain standard autodispose-lifecycle operations.
Link copied to clipboard
interface CompletableSubscribeProxy
Subscribe proxy that matches Completable's subscribe overloads.
Link copied to clipboard
interface FlowableSubscribeProxy<@NonNull T>
Subscribe proxy that matches Flowable's subscribe overloads.
Link copied to clipboard
interface MaybeSubscribeProxy<@NonNull T>
Subscribe proxy that matches Maybe's subscribe overloads.
Link copied to clipboard
interface ObservableSubscribeProxy<@NonNull T>
Subscribe proxy that matches Observable's subscribe overloads.
Link copied to clipboard
open class OutsideScopeException : RuntimeException
Signifies an error occurred due to execution starting outside the lifecycle.
Link copied to clipboard
interface ParallelFlowableSubscribeProxy<@NonNull T>
Subscribe proxy that matches ParallelFlowable's subscribe overloads.
Link copied to clipboard
@DoNotMock(value = "Use TestScopeProvider instead")
interface ScopeProvider
Provides a CompletableSource representation of a scope.
Link copied to clipboard
class Scopes
Utilities for dealing with AutoDispose scopes.
Link copied to clipboard
interface SingleSubscribeProxy<@NonNull T>
Subscribe proxy that matches Single's subscribe overloads.
Link copied to clipboard
class TestScopeProvider : ScopeProvider
ScopeProvider implementation for testing.

Functions

Link copied to clipboard
@CheckReturnValue
inline fun Completable.autoDispose(provider: ScopeProvider): CompletableSubscribeProxy
@CheckReturnValue
inline fun Completable.autoDispose(scope: Completable): CompletableSubscribeProxy

Extension that proxies to Completable.as + AutoDispose.autoDisposable

@CheckReturnValue
inline fun <T : Any> Flowable<T>.autoDispose(provider: ScopeProvider): FlowableSubscribeProxy<T>
@CheckReturnValue
inline fun <T : Any> Flowable<T>.autoDispose(scope: Completable): FlowableSubscribeProxy<T>

Extension that proxies to Flowable.as + AutoDispose.autoDisposable

@CheckReturnValue
inline fun <T : Any> Maybe<T>.autoDispose(provider: ScopeProvider): MaybeSubscribeProxy<T>
@CheckReturnValue
inline fun <T : Any> Maybe<T>.autoDispose(scope: Completable): MaybeSubscribeProxy<T>

Extension that proxies to Maybe.as + AutoDispose.autoDisposable

@CheckReturnValue
inline fun <T : Any> Observable<T>.autoDispose(provider: ScopeProvider): ObservableSubscribeProxy<T>
@CheckReturnValue
inline fun <T : Any> Observable<T>.autoDispose(scope: Completable): ObservableSubscribeProxy<T>

Extension that proxies to Observable.as + AutoDispose.autoDisposable

@CheckReturnValue
inline fun <T : Any> Single<T>.autoDispose(provider: ScopeProvider): SingleSubscribeProxy<T>
@CheckReturnValue
inline fun <T : Any> Single<T>.autoDispose(scope: Completable): SingleSubscribeProxy<T>

Extension that proxies to Single.as + AutoDispose.autoDisposable

@CheckReturnValue
inline fun <T : Any> ParallelFlowable<T>.autoDispose(provider: ScopeProvider): ParallelFlowableSubscribeProxy<T>
@CheckReturnValue
inline fun <T : Any> ParallelFlowable<T>.autoDispose(scope: Completable): ParallelFlowableSubscribeProxy<T>

Extension that proxies to ParallelFlowable.as + AutoDispose.autoDisposable

Link copied to clipboard
inline fun withScope(scope: ScopeProvider, body: AutoDisposeContext.() -> Unit)

Executes a body with an AutoDisposeContext backed by the given scope.

inline fun withScope(completableScope: Completable, body: AutoDisposeContext.() -> Unit)

Executes a body with an AutoDisposeContext backed by the given completableScope.