NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

FIx broken link warnings

Browse source
This commit is contained in:
Ulf Lilleengen 2022-06-15 09:05:48 +02:00
parent 624e46ccfb
commit 746bc75a8e
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
embassy/src/channel/mpmc.rs
View file

@ -433,7 +433,7 @@ where
/// Attempt to immediately send a message. /// Attempt to immediately send a message.
/// ///
/// This method differs from [`send`] by returning immediately if the channel's /// This method differs from [`send`](Channel::send) by returning immediately if the channel's
/// buffer is full, instead of waiting. /// buffer is full, instead of waiting.
/// ///
/// # Errors /// # Errors

8
embassy/src/executor/raw/mod.rs
View file

@ -5,7 +5,7 @@
//! ## WARNING: here be dragons! //! ## WARNING: here be dragons!
//! //!
//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe //! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe
//! executor wrappers in [`crate::executor`] and the [`crate::task`] macro, which are fully safe. //! executor wrappers in [`executor`](crate::executor) and the [`embassy::task`](embassy_macros::task) macro, which are fully safe.
mod run_queue; mod run_queue;
#[cfg(feature = "time")] #[cfg(feature = "time")]
@ -115,7 +115,7 @@ impl TaskHeader {
/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished /// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished
/// running. Hence the relevant methods require `&'static self`. It may be reused, however. /// running. Hence the relevant methods require `&'static self`. It may be reused, however.
/// ///
/// Internally, the [embassy::task](crate::task) macro allocates an array of `TaskStorage`s /// Internally, the [embassy::task](embassy_macros::task) macro allocates an array of `TaskStorage`s
/// in a `static`. The most common reason to use the raw `Task` is to have control of where /// in a `static`. The most common reason to use the raw `Task` is to have control of where
/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc. /// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc.
@ -158,7 +158,7 @@ impl<F: Future + 'static> TaskStorage<F> {
/// ///
/// This function will fail if the task is already spawned and has not finished running. /// This function will fail if the task is already spawned and has not finished running.
/// In this case, the error is delayed: a "poisoned" SpawnToken is returned, which will /// In this case, the error is delayed: a "poisoned" SpawnToken is returned, which will
/// cause [`Spawner::spawn()`] to return the error. /// cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
/// ///
/// Once the task has finished running, you may spawn it again. It is allowed to spawn it /// Once the task has finished running, you may spawn it again. It is allowed to spawn it
/// on a different executor. /// on a different executor.
@ -230,7 +230,7 @@ impl<F: Future + 'static, const N: usize> TaskPool<F, N> {
/// ///
/// This will loop over the pool and spawn the task in the first storage that /// This will loop over the pool and spawn the task in the first storage that
/// is currently free. If none is free, a "poisoned" SpawnToken is returned, /// is currently free. If none is free, a "poisoned" SpawnToken is returned,
/// which will cause [`Spawner::spawn()`] to return the error. /// which will cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
pub fn spawn(&'static self, future: impl FnOnce() -> F) -> SpawnToken<impl Sized> { pub fn spawn(&'static self, future: impl FnOnce() -> F) -> SpawnToken<impl Sized> {
for task in &self.pool { for task in &self.pool {
if task.spawn_mark_used() { if task.spawn_mark_used() {