mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2024-10-24 05:09:52 +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.
866 commits 14 branches 38 tags 14 MiB
Rust 98.6%
CSS 1.2%
Shell 0.2%
Find a file
Maxwell Elliot Heiber d80d10d0c4 Fix mdbook warning re "Potential incomplete link" 
In cycle.md, change `[salsa::Cycle]`
to `salsa::Cycle` so mdbook doesn't get confused
and think there is a broken Markdown link.

The warning was as follows:

```
warning: Potential incomplete link
  ┌─ cycles.md:3:131
  │
3 │ By default, when Salsa detects a cycle in the computation graph, Salsa will panic with a [`salsa::Cycle`] as the panic value. The [`salsa::Cycle`] structure that describes the cycle, which can be useful for diagnosing what went wrong.
  │                                                                                                                                   ^^^^^^^^^^^^^^^^ Did you forget to define a URL for ``salsa::Cycle``?
  │
  = hint: declare the link's URL. For example: `[`salsa::Cycle`]: http://example.com/`
```

After fixing this problem, there are no more mdbook warnings.
2022-01-23 19:55:02 +00:00
.github/workflows Update book workflow 2021-09-28 22:03:05 +02:00
book Fix mdbook warning re "Potential incomplete link" 2022-01-23 19:55:02 +00:00
components/salsa-macros Merge #290 2022-01-21 18:38:10 +00:00
examples Remove ': salsa::Database' bound from two examples 2021-12-30 11:02:30 +00:00
src Merge #288 #289 2022-01-21 18:35:51 +00:00
tests don't recover when not a participant 2021-11-12 05:50:06 -05:00
.dir-locals.el ask emacs to rustfmt on save 2018-09-28 11:26:57 -04:00
.gitignore update travis to test book and publish 2019-01-31 10:33:28 -05:00
bors.toml Update book workflow 2021-09-28 22:03:05 +02:00
Cargo.toml Merge #287 2022-01-21 18:33:32 +00:00
FAQ.md Update New Mexico state question 2020-06-26 15:48:29 +01: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 Setup GitHub actions 2020-06-25 12:22:03 +02:00
RELEASES.md highlight breaking changes 2019-08-15 08:08:00 -04:00

README.md

salsa

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

Want to learn more?

To learn more about Salsa, try one of the following:

Getting in touch

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