volo-build 0.12.2

Compile thrift and protobuf idls into rust code at compile-time.
Documentation 
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

<picture>
  <source media="(prefers-color-scheme: light)" srcset="https://github.com/cloudwego/volo/raw/main/.github/assets/volo-light.png?sanitize=true" />
  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/cloudwego/volo/raw/main/.github/assets/volo-dark.png?sanitize=true" />
  <img alt="Volo" src="https://github.com/cloudwego/volo/raw/main/.github/assets/volo-light.png?sanitize=true" />
</picture>

volo-build compiles thrift and protobuf idl files into rust code at compile-time.

## Example

Usually, if you are using `volo-cli` to generate the code, you don't need to use `volo-build` directly.

If you want to use `volo-build` directly, you can follow the following steps:

First, add `volo-build` to your `Cargo.toml`:

```toml
[build-dependencies]
volo-build = "*" # make sure you use a compatible version with `volo`
```

Second, creates a `build.rs` file:

```rust,ignore
fn main() {
    volo_build::Builder::default().write().unwrap();
}
```

Third, creates a `volo.yml` file in the same directory of `build.rs` with the following layout:

```yaml
---
idls:
  - source: local
    path: path/to/your/idl.thrift
  - source: local
    path: path/to/your/protobuf/idl.proto
    includes:
    - path/to/your/protobuf/
  - source: git
    repo: git@github.com:cloudwego/volo.git
    ref: main
    path: path/in/repo/idl.thrift
```

That's it!