mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2025-01-13 00:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Remove inaccurate note about mixed cycles failing to recover

Browse source 
This may have been true in the past, but both the Salsa 2022 and original tests demonstrate recovery from a cycle where only a subset of the cycle queries have recovery functions.
This commit is contained in:
Ken Micklas 2022-10-02 10:40:59 +01:00
parent 30b5e9760a
commit 2aea083877
1 changed files with 1 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
book/src/cycles/fallback.md
View file

@ -13,10 +13,6 @@ fn my_recover_fn(
) -> MyResultValue
```
The `db` and `cycle` argument can be used to prepare a useful error message for your users.
The `db` and `cycle` argument can be used to prepare a useful error message for your users.
**Important:** Although the recovery function is given a `db` handle, you should be careful to avoid creating a cycle from within recovery or invoking queries that may be participating in the current cycle. Attempting to do so can result in inconsistent results.
## Figuring out why recovery did not work
If a cycle occurs and *some* of the participant queries have `#[salsa::cycle]` annotations and others do not, then the query will be treated as irrecoverable and will simply panic. You can use the `Cycle::unexpected_participants` method to figure out why recovery did not succeed and add the appropriate `#[salsa::cycle]` annotations.