| [//]: # (title: Coroutines guide) |
| |
| Kotlin provides only minimal low-level APIs in its standard library to enable other |
| libraries to utilize coroutines. Unlike many other languages with similar capabilities, `async` and `await` |
| are not keywords in Kotlin and are not even part of its standard library. Moreover, Kotlin's concept |
| of _suspending function_ provides a safer and less error-prone abstraction for asynchronous |
| operations than futures and promises. |
| |
| `kotlinx.coroutines` is a rich library for coroutines developed by JetBrains. It contains a number of high-level |
| coroutine-enabled primitives that this guide covers, including `launch`, `async`, and others. |
| |
| This is a guide about the core features of `kotlinx.coroutines` with a series of examples, divided up into different topics. |
| |
| In order to use coroutines as well as follow the examples in this guide, you need to add a dependency on the `kotlinx-coroutines-core` module as explained |
| [in the project README](https://github.com/Kotlin/kotlinx.coroutines/blob/master/README.md#using-in-your-projects). |
| |
| ## Table of contents |
| |
| * [Coroutines basics](coroutines-basics.md) |
| * [Hands-on: Intro to coroutines and channels](https://play.kotlinlang.org/hands-on/Introduction%20to%20Coroutines%20and%20Channels) |
| * [Cancellation and timeouts](cancellation-and-timeouts.md) |
| * [Composing suspending functions](composing-suspending-functions.md) |
| * [Coroutine context and dispatchers](coroutine-context-and-dispatchers.md) |
| * [Asynchronous Flow](flow.md) |
| * [Channels](channels.md) |
| * [Coroutine exceptions handling](exception-handling.md) |
| * [Shared mutable state and concurrency](shared-mutable-state-and-concurrency.md) |
| * [Select expression (experimental)](select-expression.md) |
| * [Tutorial: Debug coroutines using IntelliJ IDEA](debug-coroutines-with-idea.md) |
| * [Tutorial: Debug Kotlin Flow using IntelliJ IDEA](debug-flow-with-idea.md) |
| |
| ## Additional references |
| |
| * [Guide to UI programming with coroutines](https://github.com/Kotlin/kotlinx.coroutines/blob/master/ui/coroutines-guide-ui.md) |
| * [Coroutines design document (KEEP)](https://github.com/Kotlin/KEEP/blob/master/proposals/coroutines.md) |
| * [Full kotlinx.coroutines API reference](https://kotlinlang.org/api/kotlinx.coroutines/) |
| * [Best practices for coroutines in Android](https://developer.android.com/kotlin/coroutines/coroutines-best-practices) |
| * [Additional Android resources for Kotlin coroutines and flow](https://developer.android.com/kotlin/coroutines/additional-resources) |
