diff options
Diffstat (limited to 'embassy-futures/README.md')
| -rw-r--r-- | embassy-futures/README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/embassy-futures/README.md b/embassy-futures/README.md new file mode 100644 index 000000000..971f4c835 --- /dev/null +++ b/embassy-futures/README.md | |||
| @@ -0,0 +1,9 @@ | |||
| 1 | # embassy-futures | ||
| 2 | |||
| 3 | Utilities for working with futures: | ||
| 4 | |||
| 5 | - [`select`](select::select) - waiting for one out of two futures to complete. | ||
| 6 | - [`select3`](select::select3) - waiting for one out of three futures to complete. | ||
| 7 | - [`select4`](select::select4) - waiting for one out of four futures to complete. | ||
| 8 | - [`select_all`](select::select_all) - waiting for one future in a list of futures to complete. | ||
| 9 | - [`yield_now`](yield_now::yield_now) - yielding the current task. | ||
