AndroidXConsumerKt

Added in 1.8.0

---

Kotlin |Java

public final class AndroidXConsumerKt

---

Summary

Public methods
static final @NonNull Consumer<@NonNull T>	<T extends Object> asAndroidXConsumer(@NonNull Continuation<@NonNull T> receiver) Returns a Consumer that will resume this Continuation when the result of an operation is accepted.

Public methods

asAndroidXConsumer

Artifact: androidx.core:core-ktx

View Source

public static final @NonNull Consumer<@NonNull T> <T extends Object> asAndroidXConsumer(@NonNull Continuation<@NonNull T> receiver)

Returns a Consumer that will resume this Continuation when the result of an operation is accepted.

Useful for writing suspend bindings to async Jetpack library methods that accept Consumer as a result callback for a one-time operation:

public suspend fun FancinessManager.query(
    query: FancinessManager.Query
): FancinessManager.QueryResult = suspendCancellableCoroutine<QueryResult> { continuation ->

    // Any Android API that supports cancellation should be configured to propagate
    // coroutine cancellation as follows:
    val canceller = CancellationSignal()
    continuation.invokeOnCancellation { canceller.cancel() }

    // Invoke the FancinessManager#queryAsync method as follows:
    queryAsync(
        query,
        canceller,
        // Use a direct executor to avoid extra dispatch. Resuming the continuation will
        // handle getting to the right thread or pool via the ContinuationInterceptor.
        Runnable::run,
        continuation.asAndroidXConsumer()
    )
}