Skip to content

Commit 6fc9631

Browse files
authored
codegen: mention Rust in the README
Updated README to reflect support for the Rust extractor and added details about Rust generated files.
1 parent d709343 commit 6fc9631

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

misc/codegen/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Code generation suite
22

3-
This directory contains the code generation suite used by the Swift extractor and the QL library. This suite will use
4-
the abstract class specification of `schema.py` to generate:
3+
This directory contains the code generation suite used by the Swift and Rust extractors and QL library. This suite will use
4+
the abstract class specification of a `schema` python module to generate:
55

66
* the `dbscheme` file (see [`dbschemegen.py`](generators/dbschemegen.py))
77
* the QL generated code and when appropriate the corresponding stubs (see [`qlgen.py`](generators/qlgen.py))
8-
* C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
9-
* C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
8+
* QL language tests for testing the extractors (see [`qlgen.py`](generators/qlgen.py))
9+
* [Swift] C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
10+
* [Swift] C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
11+
* [Rust] Rust structured classes (see [`rustgen.py`](generators/rustgen.py))
12+
* [Rust] Rust sources for extractor language tests extracted from the documentation snippets (see [`rusttestgen.py`](generators/rusttestgen.py))
1013

11-
An example `schema.py` [can be found in the Swift package](../../swift/schema.py).
14+
Schemas [can be found in the Swift package](../../swift/schema.py) or [in the Rust one](../../rust/schema).
1215

1316
## Usage
1417

0 commit comments

Comments
 (0)