diff options
| author | Ulf Lilleengen <[email protected]> | 2022-08-23 14:05:17 +0200 |
|---|---|---|
| committer | Ulf Lilleengen <[email protected]> | 2022-08-23 14:05:17 +0200 |
| commit | b6bc627b24e0ad3b2e8a45ddf9b34b32f5b2e780 (patch) | |
| tree | dc2818f85297fb43777d0f90fe8127ca6ffb2a51 /embassy-futures | |
| parent | 189d4137ccff37fc9bbf889652f634f511f8cf83 (diff) | |
Add README for embassy-futures
Diffstat (limited to 'embassy-futures')
| -rw-r--r-- | embassy-futures/README.md | 9 | ||||
| -rw-r--r-- | embassy-futures/src/lib.rs | 2 |
2 files changed, 10 insertions, 1 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. | ||
diff --git a/embassy-futures/src/lib.rs b/embassy-futures/src/lib.rs index 48c9c8574..45bea2529 100644 --- a/embassy-futures/src/lib.rs +++ b/embassy-futures/src/lib.rs | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | #![no_std] | 1 | #![no_std] |
| 2 | #![doc = include_str!("../../README.md")] | 2 | #![doc = include_str!("../README.md")] |
| 3 | #![warn(missing_docs)] | 3 | #![warn(missing_docs)] |
| 4 | 4 | ||
| 5 | // This mod MUST go first, so that the others see its macros. | 5 | // This mod MUST go first, so that the others see its macros. |