Add grpc-rust documentation: language landing page, quickstart, and route guide (#1511)#1517
Merged
Conversation
…oute guide (grpc#1511) Add gRPC Rust Documentation
ejona86
approved these changes
May 22, 2026
Member
ejona86
left a comment
ejona86
left a comment
There was a problem hiding this comment.
Seems you should have more PR description about when you do want this to go in.
arjan-bal
reviewed
May 27, 2026
| the repo: | ||
|
|
||
| ```sh | ||
| git clone -b {{< param grpc_vers.rust >}} --depth 1 https://github.com/grpc/grpc-rust |
Contributor
There was a problem hiding this comment.
The command clones the v0.9.0 tag used for a three year old tonic release. We should use a gRPC specific tag instead.
git clone -b v0.9.0 --depth 1 https://github.com/grpc/grpc-rust
Member
Author
There was a problem hiding this comment.
Oh wow, yes I didn't think of that. I'll go with grpc-v0.9.0
Comment on lines
+14
to
+27
| - **[Protocol buffer][pb] compiler**, `protoc`, [version 34.0][proto34]. | ||
|
|
||
| For installation instructions, see [Protocol Buffer Compiler | ||
| Installation][pbc-install]. Note that because Rust support in `protoc` is not | ||
| yet stable, the version installed must be exactly 34.0. | ||
|
|
||
| - **gRPC-Rust plugin** for the protocol compiler: | ||
|
|
||
| 1. A C++17 compatible compiler and CMake 3.14 or higher are required to | ||
| compile the protobuf code generation tool. | ||
| 2. Follow the detailed instructions on the [`protoc-gen-rust-grpc`][pgrg] page | ||
| to compile and install the plugin. | ||
| 3. Be sure to update your `PATH` so that the `protoc` compiler can find the | ||
| plugin. |
Contributor
There was a problem hiding this comment.
With the changes in grpc/grpc-rust#2654, users no longer need to manually install protoc or the protoc-gen-rust-grpc plugin and add them to their PATH. Instead, they can simply use the --features grpc-protobuf-build/build-plugin flag to compile them from source. Alternatively, users can edit the Cargo.toml to enable the grpc-protobuf-build/build-plugin feature.
cargo run --bin helloworld-server --features grpc-protobuf-build/build-plugin
Comment on lines
+126
to
+130
| ```sh | ||
| protoc --rust_out=src/grpc-helloworld/generated/ --rust_opt=experimental-codegen=enabled,kernel=upb \ | ||
| --rust-grpc_out=src/grpc-helloworld/generated/ --rust-grpc_opt=client_only=true \ | ||
| --proto_path=proto/helloworld/ proto/helloworld/helloworld.proto | ||
| ``` |
Contributor
There was a problem hiding this comment.
Since we're now using build.rs to generate the code, we can simply run the following:
cargo build --bin grpc-helloworld-clientor
cargo build --bin grpc-helloworld-client --features grpc-protobuf-build/build-plugin
Comment on lines
+148
to
+154
| ```sh | ||
| protoc \ | ||
| --rust_out=src/grpc-routeguide/generated/ --rust_opt=experimental-codegen=enabled,kernel=upb \ | ||
| --rust-grpc_out=src/grpc-routeguide/generated/ --rust-grpc_opt=client_only=true \ | ||
| --proto_path=proto/routeguide/ \ | ||
| proto/routeguide/route_guide.proto | ||
| ``` |
Contributor
There was a problem hiding this comment.
This can be replaced with a cargo build now.
cargo build --bin grpc-routeguide-client
We should also explain the addition of grpc_protobuf_build::CodeGen call the build.rs file.
Comment on lines
+37
to
+39
| changes are made to your proto definitions. However, it requires anyone who | ||
| wants to compile your crate to have `protoc` installed, and the proper C++ | ||
| requirements for building the `protoc-gen-rust-grpc` binary. |
Contributor
There was a problem hiding this comment.
With the changes from grpc/grpc-rust#2654, the default behaviour is to compile protoc and the plugin from source. This sentence needs to be updated.
dfawley
commented
May 27, 2026
Member
Author
dfawley
left a comment
dfawley
left a comment
There was a problem hiding this comment.
Updated; thank you for the review
| the repo: | ||
|
|
||
| ```sh | ||
| git clone -b {{< param grpc_vers.rust >}} --depth 1 https://github.com/grpc/grpc-rust |
Member
Author
There was a problem hiding this comment.
Oh wow, yes I didn't think of that. I'll go with grpc-v0.9.0
Comment on lines
+14
to
+27
| - **[Protocol buffer][pb] compiler**, `protoc`, [version 34.0][proto34]. | ||
|
|
||
| For installation instructions, see [Protocol Buffer Compiler | ||
| Installation][pbc-install]. Note that because Rust support in `protoc` is not | ||
| yet stable, the version installed must be exactly 34.0. | ||
|
|
||
| - **gRPC-Rust plugin** for the protocol compiler: | ||
|
|
||
| 1. A C++17 compatible compiler and CMake 3.14 or higher are required to | ||
| compile the protobuf code generation tool. | ||
| 2. Follow the detailed instructions on the [`protoc-gen-rust-grpc`][pgrg] page | ||
| to compile and install the plugin. | ||
| 3. Be sure to update your `PATH` so that the `protoc` compiler can find the | ||
| plugin. |
Comment on lines
+148
to
+154
| ```sh | ||
| protoc \ | ||
| --rust_out=src/grpc-routeguide/generated/ --rust_opt=experimental-codegen=enabled,kernel=upb \ | ||
| --rust-grpc_out=src/grpc-routeguide/generated/ --rust-grpc_opt=client_only=true \ | ||
| --proto_path=proto/routeguide/ \ | ||
| proto/routeguide/route_guide.proto | ||
| ``` |
Comment on lines
+37
to
+39
| changes are made to your proto definitions. However, it requires anyone who | ||
| wants to compile your crate to have `protoc` installed, and the proper C++ | ||
| requirements for building the `protoc-gen-rust-grpc` binary. |
Comment on lines
+126
to
+130
| ```sh | ||
| protoc --rust_out=src/grpc-helloworld/generated/ --rust_opt=experimental-codegen=enabled,kernel=upb \ | ||
| --rust-grpc_out=src/grpc-helloworld/generated/ --rust-grpc_opt=client_only=true \ | ||
| --proto_path=proto/helloworld/ proto/helloworld/helloworld.proto | ||
| ``` |
ejona86
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is identical to #1511, rolled back in #1516 since we don't want it live yet.