1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# Rust Infrastructure
## Bindings
| directory | bindings for |
| --------------- | ------------ |
| papers-document | libdocument |
| papers-view | libview |
Bindings are generated by [gir](https://github.com/gtk-rs/gir) and `*.gir` inside `rust/gir-files`. Before generating the bindings, you should checkout the submodule and install `gir` command.
```
git submodule update --checkout
cd rust/gir
cargo install --path .
```
There is a meson run target named `update-rust-bindings` to update the bindings. The run target depends on the gobject introspection feature and can be invoked by:
```
meson setup _build -Dintrospection=enabled
meson compile -C _build update-rust-bindings
```
You can also update the bindings through the `shell/update-bindings.sh` script.
## Handle Conflicts
It's fairly common that several MR update the Rust binding code and introduce conflicts. The best practice of solving this kind of conflicts is:
1. Split the binding update into a separated commit.
2. Only solve the conflicts inside hand-written files (Gir.toml for example), then regenerating others and commit them all. In this way the auto-generated bindings are overwritten without handling any conflicts.
For example:
```bash
$ git rebase -i origin/main
$ # encounter binding update conflicts
$ # edit rust/papers-view/Gir.toml and rust/papers-document/Gir.toml to solve conflicts
$ meson compile -C _build update-rust-bindings
$ meson compile -C _build # do the build test
$ git add rust/
$ git rebase --continue # solve the conflict
```
## IDE Support
rust-analyzer needs some environment to function properly. The environment can be set by `meson devenv`:
```bash
meson _build
meson devenv -C _build
code ..
```
|
