mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2024-11-24 04:09:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review

Browse source 
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
This commit is contained in:
Carl Meyer 2024-07-29 09:15:47 -07:00 committed by GitHub
parent 2ea6759b0f
commit 8e2a784b8e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,13 +4,15 @@ Panicking when a cycle occurs is ok for situations where you believe a cycle is
To use cycle recovery, you annotate potential participants in the cycle with the `recovery_fn` argument to `#[salsa::tracked]`, e.g. `#[salsa::tracked(recovery_fn=my_recovery_fn)]`. When a cycle occurs, if any participant P has recovery information, then no panic occurs. Instead, the execution of P is aborted and P will execute the recovery function to generate its result. Participants in the cycle that do not have recovery information continue executing as normal, using this recovery result.
The recovery function has a similar signature to a query function. It is given a reference to your database along with a `salsa::Cycle` describing the cycle that occurred and the input ingredient to the query that caused the cycle; it returns the result of the query. Example:
The recovery function has a similar signature to a query function. It is given a reference to your database along with a `salsa::Cycle` describing the cycle that occurred and the arguments to the tracked function that caused the cycle; it returns the result of the query. Example:
```rust
fn my_recover_fn(
db: &dyn MyDatabase,
cycle: &salsa::Cycle,
input: MyIngredient,
arg1: T1,
...
argN: TN,
) -> MyResultValue
```