diff options
| author | Dániel Buga <[email protected]> | 2025-08-04 00:05:25 +0200 |
|---|---|---|
| committer | Dániel Buga <[email protected]> | 2025-08-18 12:50:51 +0200 |
| commit | 74037f04933f4ec9a678e0b47fd6819e7c0489a9 (patch) | |
| tree | cb81e7394b6b59324a08eb92eba6fd0d8d9f2a9c /embassy-executor-timer-queue/README.md | |
| parent | a5cb04bdab602bc3bd056d254a9d61cad55bd967 (diff) | |
Make TimerQueueItem opaque
Diffstat (limited to 'embassy-executor-timer-queue/README.md')
| -rw-r--r-- | embassy-executor-timer-queue/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/embassy-executor-timer-queue/README.md b/embassy-executor-timer-queue/README.md new file mode 100644 index 000000000..602aca7b1 --- /dev/null +++ b/embassy-executor-timer-queue/README.md | |||
| @@ -0,0 +1,10 @@ | |||
| 1 | # embassy-executor-time-queue | ||
| 2 | |||
| 3 | This crate defines the timer queue item that embassy-executor provides, and a way to access it, for | ||
| 4 | executor-integrated timer queues. The crate decouples the release cycle of embassy-executor from | ||
| 5 | that of the queue implementations'. | ||
| 6 | |||
| 7 | As a HAL implementer, you only need to depend on this crate if you want to implement executor-integrated | ||
| 8 | timer queues yourself, without using [`embassy-time-queue-utils`](https://crates.io/crates/embassy-time-queue-utils). | ||
| 9 | |||
| 10 | As a HAL user, you should not need to depend on this crate. | ||