aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--embassy/src/channel/mpmc.rs2
-rw-r--r--embassy/src/executor/raw/mod.rs8
2 files changed, 5 insertions, 5 deletions
diff --git a/embassy/src/channel/mpmc.rs b/embassy/src/channel/mpmc.rs
index 48056cd8f..1d03eef19 100644
--- a/embassy/src/channel/mpmc.rs
+++ b/embassy/src/channel/mpmc.rs
@@ -433,7 +433,7 @@ where
433 433
434 /// Attempt to immediately send a message. 434 /// Attempt to immediately send a message.
435 /// 435 ///
436 /// This method differs from [`send`] by returning immediately if the channel's 436 /// This method differs from [`send`](Channel::send) by returning immediately if the channel's
437 /// buffer is full, instead of waiting. 437 /// buffer is full, instead of waiting.
438 /// 438 ///
439 /// # Errors 439 /// # Errors
diff --git a/embassy/src/executor/raw/mod.rs b/embassy/src/executor/raw/mod.rs
index 09429c19a..b8455442e 100644
--- a/embassy/src/executor/raw/mod.rs
+++ b/embassy/src/executor/raw/mod.rs
@@ -5,7 +5,7 @@
5//! ## WARNING: here be dragons! 5//! ## WARNING: here be dragons!
6//! 6//!
7//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe 7//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe
8//! executor wrappers in [`crate::executor`] and the [`crate::task`] macro, which are fully safe. 8//! executor wrappers in [`executor`](crate::executor) and the [`embassy::task`](embassy_macros::task) macro, which are fully safe.
9 9
10mod run_queue; 10mod run_queue;
11#[cfg(feature = "time")] 11#[cfg(feature = "time")]
@@ -115,7 +115,7 @@ impl TaskHeader {
115/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished 115/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished
116/// running. Hence the relevant methods require `&'static self`. It may be reused, however. 116/// running. Hence the relevant methods require `&'static self`. It may be reused, however.
117/// 117///
118/// Internally, the [embassy::task](crate::task) macro allocates an array of `TaskStorage`s 118/// Internally, the [embassy::task](embassy_macros::task) macro allocates an array of `TaskStorage`s
119/// in a `static`. The most common reason to use the raw `Task` is to have control of where 119/// in a `static`. The most common reason to use the raw `Task` is to have control of where
120/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc. 120/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc.
121 121
@@ -158,7 +158,7 @@ impl<F: Future + 'static> TaskStorage<F> {
158 /// 158 ///
159 /// This function will fail if the task is already spawned and has not finished running. 159 /// This function will fail if the task is already spawned and has not finished running.
160 /// In this case, the error is delayed: a "poisoned" SpawnToken is returned, which will 160 /// In this case, the error is delayed: a "poisoned" SpawnToken is returned, which will
161 /// cause [`Spawner::spawn()`] to return the error. 161 /// cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
162 /// 162 ///
163 /// Once the task has finished running, you may spawn it again. It is allowed to spawn it 163 /// Once the task has finished running, you may spawn it again. It is allowed to spawn it
164 /// on a different executor. 164 /// on a different executor.
@@ -230,7 +230,7 @@ impl<F: Future + 'static, const N: usize> TaskPool<F, N> {
230 /// 230 ///
231 /// This will loop over the pool and spawn the task in the first storage that 231 /// This will loop over the pool and spawn the task in the first storage that
232 /// is currently free. If none is free, a "poisoned" SpawnToken is returned, 232 /// is currently free. If none is free, a "poisoned" SpawnToken is returned,
233 /// which will cause [`Spawner::spawn()`] to return the error. 233 /// which will cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
234 pub fn spawn(&'static self, future: impl FnOnce() -> F) -> SpawnToken<impl Sized> { 234 pub fn spawn(&'static self, future: impl FnOnce() -> F) -> SpawnToken<impl Sized> {
235 for task in &self.pool { 235 for task in &self.pool {
236 if task.spawn_mark_used() { 236 if task.spawn_mark_used() {