volo-build

Crates.iovolo-build
lib.rsvolo-build
version0.10.6
sourcesrc
created_at2022-08-23 07:19:52.659603
updated_at2024-05-15 06:50:44.358984
descriptionCompile thrift and protobuf idls into rust code at compile-time.
homepagehttps://www.cloudwego.io/docs/volo/
repositoryhttps://github.com/cloudwego/volo
max_upload_size
id650814
size117,874
Volo-maintainers (github:cloudwego:volo-maintainers)

documentation

https://docs.rs/volo-build

README

Volo

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:

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

Second, creates a build.rs file:

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:

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

Commit count: 371

cargo fmt