Support for Closeables

Khonshu’s Codegen supports java.io.Closeables by propagating each Closeable contributed to a scoped Component to be bound to its internal androidx.lifecycle.ViewModel. When the corresponding NavDestination is cleared from the back stack and hence ViewModel.onCleared() is called, all bound Closeables will be automatically closed.

This can be used to run any kind of cleanup you normally do in ViewModel.onCleared().

Kotlin CoroutineScopeRxJava CompositeDisposable

// marker class for the scope
sealed interface ExampleScope

@Module
@ContributesTo(ExampleScope::class)
object ExampleModule {
    @Provides
    @SingleIn(ExampleScope::class)
    fun provideCoroutineScope(): CoroutineScope = MainScope()

    // Closeable to cancel CoroutineScope
    @Provides
    @IntoSet
    fun bindCoroutineScope(scope: CoroutineScope): Closeable = Closeable { scope.cancel() }
}

// marker class for the scope
sealed interface ExampleScope

@Module
@ContributesTo(ExampleScope::class)
object ExampleModule {
    @Provides
    @SingleIn(ExampleScope::class)
    fun provideCompositeDisposable(): CompositeDisposable = CompositeDisposable()

    // Closeable to clear CompositeDisposable
    @Provides
    @IntoSet
    fun bindCompositeDisposable(disposable: CompositeDisposable): Closeable = Closeable { disposable.clear() }
}