#compiler #grpc #protobuf #grpc-rs

protoc-grpcio

API for programatically invoking the grpcio (grpc-rs) gRPC compiler

13 releases (7 stable)

Uses old Rust 2015

3.0.0 Dec 9, 2020
2.0.0 Jun 22, 2020
1.3.0 Jun 17, 2020
1.1.0 Sep 26, 2019
0.1.0 Jan 25, 2018

#1973 in Network programming

Download history 4351/week @ 2022-08-08 2421/week @ 2022-08-15 2346/week @ 2022-08-22 2597/week @ 2022-08-29 3791/week @ 2022-09-05 3985/week @ 2022-09-12 4968/week @ 2022-09-19 4335/week @ 2022-09-26 4156/week @ 2022-10-03 3231/week @ 2022-10-10 4620/week @ 2022-10-17 3026/week @ 2022-10-24 3944/week @ 2022-10-31 3029/week @ 2022-11-07 3366/week @ 2022-11-14 2180/week @ 2022-11-21

12,673 downloads per month
Used in fewer than 8 crates

Apache-2.0

16KB
250 lines

protoc-grpcio

crates.io Build Status License

A programmatic API to the grpc-rs compiler.

Requirements

  • You must have Google's Protocol Buffer compiler (protoc) installed and in PATH.

Example build.rs

For a project laid out like so:

$ tree
.
├── build.rs
├── Cargo.toml
└── src
    ├── client.rs
    ├── protos
       ├── example
       │   └── diner.proto
       └── mod.rs
    └── server.rs

3 directories, 7 files

The build.rs might look like:

extern crate protoc_grpcio;

fn main() {
    let proto_root = "src/protos";
    println!("cargo:rerun-if-changed={}", proto_root);
    protoc_grpcio::compile_grpc_protos(
        &["example/diner.proto"],
        &[proto_root],
        &proto_root,
        None
    ).expect("Failed to compile gRPC definitions!");
}

Example Cargo.toml

And the Cargo.toml might look like:

[package]
# ...
build = "build.rs"

[lib]
name = "protos"
path = "src/protos/mod.rs"

[[bin]]
name = "server"
path = "src/server.rs"

[[bin]]
name = "client"
path = "src/client.rs"

[dependencies]
futures = "0.1.16"
grpcio = "0.4.3"
protobuf = "~2"

[build-dependencies]
protoc-grpcio = "1.0.2"

You can inspect this example under example/ by compiling and running the example server in one shell session:

cargo run --manifest-path example/Cargo.toml --bin server
...
    Finished dev [unoptimized + debuginfo] target(s) in 27.97 secs
     Running `example/target/debug/server`
listening on 127.0.0.1:34431

And then running the client in another:

$ cargo run --manifest-path example/Cargo.toml --bin client 34431
...
    Finished dev [unoptimized + debuginfo] target(s) in 1.28 secs
     Running `example/target/debug/client 34431`
Ate items: SPAM items: EGGS and got charged $0.30

Credits

Credit to both the TiKV project developers for (grpc-rs) and Stepan Koltsov (@stepancheg, rust-protobuf) for their amazing work bringing Protocol Buffers and gRPC support to Rust.

Dependencies

~2MB
~43K SLoC