mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-26 05:29:38 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge #404

Browse source 
404: Fixup app/tips r=korken89 a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
This commit is contained in:
bors[bot] 2020-11-12 17:20:36 +00:00 committed by GitHub
commit b4ca29f69c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
book/en/src/by-example/tips.md
View file

@ -2,15 +2,8 @@
## Generics ## Generics
Resources may appear in contexts as resource proxies or as unique references All resource proxies implement the `rtic::Mutex` trait.
(`&mut-`) depending on the priority of the task. Because the same resource may If a resource does not implement this, one can wrap it in the [`rtic::Exclusive`]
appear as *different* types in different contexts one cannot refactor a common
operation that uses resources into a plain function; however, such refactor is
possible using *generics*.
All resource proxies implement the `rtic::Mutex` trait. On the other hand,
unique references (`&mut-`) do *not* implement this trait (due to limitations in
the trait system) but one can wrap these references in the [`rtic::Exclusive`]
newtype which does implement the `Mutex` trait. With the help of this newtype newtype which does implement the `Mutex` trait. With the help of this newtype
one can write a generic function that operates on generic resources and call it one can write a generic function that operates on generic resources and call it
from different tasks to perform some operation on the same set of resources. from different tasks to perform some operation on the same set of resources.
@ -27,15 +20,13 @@ $ cargo run --example generics
{{#include ../../../../ci/expected/generics.run}} {{#include ../../../../ci/expected/generics.run}}
``` ```
Using generics also lets you change the static priorities of tasks during
development without having to rewrite a bunch code every time.
## Conditional compilation ## Conditional compilation
You can use conditional compilation (`#[cfg]`) on resources (the fields of You can use conditional compilation (`#[cfg]`) on resources (the fields of
`struct Resources`) and tasks (the `fn` items). The effect of using `#[cfg]` `#[resources] struct Resources`) and tasks (the `fn` items).
attributes is that the resource / task will *not* be available through the The effect of using `#[cfg]` attributes is that the resource / task
corresponding `Context` `struct` if the condition doesn't hold. will *not* be available through the corresponding `Context` `struct`
if the condition doesn't hold.
The example below logs a message whenever the `foo` task is spawned, but only if The example below logs a message whenever the `foo` task is spawned, but only if
the program has been compiled using the `dev` profile. the program has been compiled using the `dev` profile.
@ -132,7 +123,7 @@ You can inspect the file `rtic-expansion.rs` inside the `target` directory. This
file contains the expansion of the `#[rtic::app]` item (not your whole program!) file contains the expansion of the `#[rtic::app]` item (not your whole program!)
of the *last built* (via `cargo build` or `cargo check`) RTIC application. The of the *last built* (via `cargo build` or `cargo check`) RTIC application. The
expanded code is not pretty printed by default so you'll want to run `rustfmt` expanded code is not pretty printed by default so you'll want to run `rustfmt`
over it before you read it. on it before you read it.
``` console ``` console
$ cargo build --example foo $ cargo build --example foo