mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2024-10-23 20:59:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A generic framework for on-demand, incrementalized computation. Inspired by adapton, glimmer, and rustc's query system.
390 commits 14 branches 38 tags 14 MiB
Rust 98.6%
CSS 1.2%
Shell 0.2%
Find a file
Niko Matsakis 682c29e777 publish v0.10.0-alpha5 
- Make `dyn Trait` implementations work

Contributors to this release:

- @nikomatsakis
2019-01-25 19:09:10 -05:00
components/salsa-macros publish v0.10.0-alpha5 2019-01-25 19:09:10 -05:00
examples update hello-world with the desired naming convention 2019-01-25 10:47:01 -05:00
src change #[salsa::query_group] attribute to take a struct name 2019-01-25 10:26:39 -05:00
tests make dyn Trait query implementations work 2019-01-25 18:36:23 -05:00
.dir-locals.el ask emacs to rustfmt on save 2018-09-28 11:26:57 -04:00
.gitignore warn people not to use this :) 2018-09-29 06:05:04 -04:00
.travis.yml build-on-stable etc 2018-12-13 05:32:16 -05:00
Cargo.toml publish v0.10.0-alpha5 2019-01-25 19:09:10 -05:00
FAQ.md update FAQ with a link 2018-10-02 05:52:27 -04:00
LICENSE-APACHE add readme, license, etc 2018-09-28 11:01:27 -04:00
LICENSE-MIT add readme, license, etc 2018-09-28 11:01:27 -04:00
README.md generate set_X and set_constant_X methods for each input 2019-01-25 05:18:26 -05:00

README.md

salsa

Build Status Released API docs Crates.io

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...

  1. 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).
  2. Define the query functions where appropriate.
  3. 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.

Salsa requires at least Rust 1.30 (beta at the time of writing).

Getting in touch

The bulk of the discussion happens in the issues and pull requests, but we have a zulip chat as well.