| commit | 419aa3920851361764a32055122b3d8209b32b3a | [log] [tgz] |
|---|---|---|
| author | Taiki Endo <[email protected]> | Mon Jan 20 01:52:55 2025 +0900 |
| committer | Taiki Endo <[email protected]> | Fri Jan 24 00:01:29 2025 +0900 |
| tree | e21e94be7d8d6e958e9431e8100751df766dc6f8 | |
| parent | 9266e14b4e287b15ce8c4b917c3a479657b84dea [diff] |
Fix clippy::empty_line_after_doc_comments warning
```
error: empty line after doc comment
--> src/runnable.rs:831:5
|
831 | / /// use async_task::{Runnable, spawn};
832 | |
| |_^
...
845 | pub fn into_raw(self) -> NonNull<()> {
| ------------------------------------ the comment documents this method
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
= note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
= help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
= help: if the empty line is unintentional remove it
help: if the documentation should include the empty line include it in the comment
|
832 | ///
|
error: empty lines after doc comment
--> src/runnable.rs:868:5
|
868 | / /// use async_task::{Runnable, spawn};
869 | |
870 | | /// let (runnable, task) = spawn(async {}, |_| {});
871 | | /// let runnable_pointer = runnable.into_raw();
... |
882 | | /// ```
883 | |
| |_^
884 | /// [into_raw]: #method.into_raw
885 | pub unsafe fn from_raw(ptr: NonNull<()>) -> Self {
| ------------------------------------------------ the comment documents this associated function
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
= help: if the empty lines are unintentional remove them
help: if the documentation should include the empty lines include them in the comment
|
869 + ///
870 | /// let (runnable, task) = spawn(async {}, |_| {});
...
882 | /// ```
883 + ///
|
```
Task abstraction for building executors.
To spawn a future onto an executor, we first need to allocate it on the heap and keep some state attached to it. The state indicates whether the future is ready for polling, waiting to be woken up, or completed. Such a stateful future is called a task.
All executors have a queue that holds scheduled tasks:
let (sender, receiver) = flume::unbounded();
A task is created using either spawn(), spawn_local(), or spawn_unchecked() which return a Runnable and a Task:
// A future that will be spawned. let future = async { 1 + 2 }; // A function that schedules the task when it gets woken up. let schedule = move |runnable| sender.send(runnable).unwrap(); // Construct a task. let (runnable, task) = async_task::spawn(future, schedule); // Push the task into the queue by invoking its schedule function. runnable.schedule();
The Runnable is used to poll the task's future, and the Task is used to await its output.
Finally, we need a loop that takes scheduled tasks from the queue and runs them:
for runnable in receiver { runnable.run(); }
Method run() polls the task's future once. Then, the Runnable vanishes and only reappears when its Waker wakes the task, thus scheduling it to be run again.
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.