diff options
| author | Dion Dokter <[email protected]> | 2025-07-15 14:30:02 +0200 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2025-09-11 14:45:06 +0200 |
| commit | d6d4df1c768f8ae43ad1339b74d351f4cbad0386 (patch) | |
| tree | 49db023bee0b05326baf9f6b4eb3051b25d659f2 /embassy-executor/src/raw/deadline.rs | |
| parent | 3f606b28f3b32e9e3b9a9f136eeef52828a78512 (diff) | |
Add some docs
Diffstat (limited to 'embassy-executor/src/raw/deadline.rs')
| -rw-r--r-- | embassy-executor/src/raw/deadline.rs | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/embassy-executor/src/raw/deadline.rs b/embassy-executor/src/raw/deadline.rs index a61852612..cbb379b82 100644 --- a/embassy-executor/src/raw/deadline.rs +++ b/embassy-executor/src/raw/deadline.rs | |||
| @@ -4,7 +4,11 @@ use core::task::Poll; | |||
| 4 | 4 | ||
| 5 | /// A type for interacting with the deadline of the current task | 5 | /// A type for interacting with the deadline of the current task |
| 6 | /// | 6 | /// |
| 7 | /// Requires the `edf-scheduler` feature | 7 | /// Requires the `edf-scheduler` feature. |
| 8 | /// | ||
| 9 | /// Note: Interacting with the deadline should be done locally in a task. | ||
| 10 | /// In theory you could try to set or read the deadline from another task, | ||
| 11 | /// but that will result in weird (though not unsound) behavior. | ||
| 8 | pub struct Deadline { | 12 | pub struct Deadline { |
| 9 | instant_ticks_hi: AtomicU32, | 13 | instant_ticks_hi: AtomicU32, |
| 10 | instant_ticks_lo: AtomicU32, | 14 | instant_ticks_lo: AtomicU32, |
