mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-23 20:22:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add some more

Browse source
This commit is contained in:
datdenkikniet 2023-04-22 18:25:00 +02:00
parent 1dc2f80eb6
commit d90fa95266
3 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
book/en/src/migration/migration_v2.md
View file

@ -5,11 +5,13 @@ Migrating a project from RTIC `v1.0.x` to `v2.0.0` involves the following steps:
1. `v2.0.0` requires [`#![type_alias_impl_trait]`](https://github.com/rust-lang/rust/issues/63063) and Rust Nightly. 1. `v2.0.0` requires [`#![type_alias_impl_trait]`](https://github.com/rust-lang/rust/issues/63063) and Rust Nightly.
2. Migrating from the monotonics included in `v1.0.x` to `rtic-time` and `rtic-monotonics`, replacing `spawn_after`, `spawn_at`. 2. Migrating from the monotonics included in `v1.0.x` to `rtic-time` and `rtic-monotonics`, replacing `spawn_after`, `spawn_at`.
3. Software tasks are now required to be `async`, and using them correctly. 3. Software tasks are now required to be `async`, and using them correctly.
4. Understanding and using data types provided by `rtic-sync` to solve migration problems. 4. Understanding and using data types provided by `rtic-sync`.
For a detailed description of the changes, refer to the subchapters.
If you wish to see a code example of changes required, you can check out [the full example migration page](./migration_v2/complete_example.md). If you wish to see a code example of changes required, you can check out [the full example migration page](./migration_v2/complete_example.md).
## TL;DR #### TL;DR (Too Long; Didn't Read)
1. Add `#![type_alias_impl_trait]` to your crate, and use `cargo +nightly`. 1. Add `#![type_alias_impl_trait]` to your crate, and use `cargo +nightly`.
2. Instead of `spawn_after` and `spawn_at`, you now use the `async` functions `delay`, `delay_until` (and related) with impls provided by `rtic-monotonics`. 2. Instead of `spawn_after` and `spawn_at`, you now use the `async` functions `delay`, `delay_until` (and related) with impls provided by `rtic-monotonics`.
3. Software tasks _must_ be `async fn`s now. Not returning from a task is allowed so long as there is an `await` in the task. You can still `lock` shared resources. 3. Software tasks _must_ be `async fn`s now. Not returning from a task is allowed so long as there is an `await` in the task. You can still `lock` shared resources.

2
book/en/src/migration/migration_v2/monotonics.md
View file

@ -8,4 +8,4 @@ The `#[monotonic]` attribute is no longer used. Instead, you use a `create_X_tok
Check out the [code example](./complete_example.md) for an overview of the required changes. Check out the [code example](./complete_example.md) for an overview of the required changes.
For more information on current monotonic implementations, see [the `rtic-monotonics` documentation](https://docs.rs/rtic-monotonics). For more information on current monotonic implementations, see [the `rtic-monotonics` documentation](https://docs.rs/rtic-monotonics), and [the examples](https://github.com/rtic-rs/rtic/tree/master/examples).

10
book/en/src/migration/migration_v2/rtic-sync.md
View file

@ -1 +1,9 @@
# Using `rtic-sync` # Using `rtic-sync`
`rtic-sync` provides primitives that can be used for message passing and resource sharing in async context.
The important structs are:
* The `Arbiter`, which allows you to await access to a shared resource in async contexts without using `lock`.
* `Channel`, which allows you to communicate between tasks (both `async` and non-`async`).
For more information on these structs, see the [`rtic-sync` docs](https://docs.rs/rtic-sync)