diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-12-21 19:02:49 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-21 19:02:49 +0000 |
| commit | c78177c37e3192c7a41a3ea8e7c139751c1a8989 (patch) | |
| tree | d5092fa9f154994c27f710f3ec4cacdb651fd96d /book/en/src/by-example/tips_static_lifetimes.md | |
| parent | 37facfb5bf9aca11c43868cb8880b12b9f6b336a (diff) | |
| parent | e249813ad7a5670dd9a1a70d46b72aa02ce4dce0 (diff) | |
Merge #563
563: Docs touchup r=korken89 a=AfoHT
Unleashed some language linters on the book
Co-authored-by: Henrik Tjäder <henrik@grepit.se>
Co-authored-by: perlindgren <per.lindgren@ltu.se>
Diffstat (limited to 'book/en/src/by-example/tips_static_lifetimes.md')
| -rw-r--r-- | book/en/src/by-example/tips_static_lifetimes.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/book/en/src/by-example/tips_static_lifetimes.md b/book/en/src/by-example/tips_static_lifetimes.md index 3ea0816..8d3a832 100644 --- a/book/en/src/by-example/tips_static_lifetimes.md +++ b/book/en/src/by-example/tips_static_lifetimes.md @@ -1,16 +1,16 @@ # 'static super-powers -As discussed earlier `local` resources are given `'static` lifetime in `#[init]` and `#[idle]`, -this can be used to allocate an object and then split it up or give the pre-allocated object to a -task, driver or some other object. -This is very useful when needing to allocate memory for drivers, such as USB drivers, and using -data structures that can be split such as [`heapless::spsc::Queue`]. +In `#[init]` and `#[idle]` `local` resources has `'static` lifetime. -In the following example an [`heapless::spsc::Queue`] is given to two different tasks for lock-free access -to the shared queue. +Useful when pre-allocating and/or splitting resources between tasks, drivers +or some other object. +This comes in handy when drivers, such as USB drivers, need to allocate memory and +when using splittable data structures such as [`heapless::spsc::Queue`]. -[`heapless::spsc::Queue`]: https://docs.rs/heapless/0.7.5/heapless/spsc/struct.Queue.html +In the following example two different tasks share a [`heapless::spsc::Queue`] +for lock-free access to the shared queue. +[`heapless::spsc::Queue`]: https://docs.rs/heapless/0.7.5/heapless/spsc/struct.Queue.html ``` rust {{#include ../../../../examples/static.rs}} |