0e01067d55
Quickest POC I could create to get some potentially cyclic queries to not panic and instead return a result I could act on. (gluon's module importing need to error on cycles). ``` // Causes `db.query()` to actually return `Result<V, CycleError>` fn query(&self, key: K, key2: K2) -> V; ``` A proper implementation of this would likely return `Result<V, CycleError<(K, K2)>>` or maybe larger changes are needed. cc #6 |
||
|---|---|---|
| book | ||
| components/salsa-macros | ||
| examples | ||
| src | ||
| tests | ||
| .dir-locals.el | ||
| .gitignore | ||
| .travis.yml | ||
| Cargo.toml | ||
| FAQ.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| RELEASES.md | ||
salsa
A generic framework for on-demand, incrementalized computation.
Obligatory warning
Very much a WORK IN PROGRESS at this point. Ready for experimental use but expect frequent breaking changes.
Credits
This system is heavily inspired by adapton, glimmer, and rustc's query system. So credit goes to Eduard-Mihai Burtescu, Matthew Hammer, Yehuda Katz, and Michael Woerister.
Key idea
The key idea of salsa is that you define your program as a set of
queries. Every query is used like function K -> V that maps from
some key of type K to a value of type V. Queries come in two basic
varieties:
- Inputs: the base inputs to your system. You can change these whenever you like.
- Functions: pure functions (no side effects) that transform your inputs into other values. The results of queries is memoized to avoid recomputing them a lot. When you make changes to the inputs, we'll figure out (fairly intelligently) when we can re-use these memoized values and when we have to recompute them.
How to use Salsa in three easy steps
Using salsa is as easy as 1, 2, 3...
- Define one or more query groups that contain the inputs and queries you will need. We'll start with one such group, but later on you can use more than one to break up your system into components (or spread your code across crates).
- Define the query functions where appropriate.
- Define the database, which contains the storage for all the inputs/queries you will be using. The query struct will contain the storage for all of the inputs/queries and may also contain anything else that your code needs (e.g., configuration data).
To see an example of this in action, check out the hello_world
example, which has a number of comments
explaining how things work.
Videos about Salsa
There are also two videos explaining how Salsa works:
- How Salsa Works, which gives a high-level introduction to the key concepts involved and shows how to use salsa;
- Salsa In More Depth, which really digs into the incremental algorithm and explains -- at a high-level -- how Salsa is implemented.
Getting in touch
The bulk of the discussion happens in the issues and pull requests, but we have a zulip chat as well.