Skip to content

Commit 5cfba73

Browse files
authored
Add grpc-rust documentation: language landing page, quickstart, and route guide (#1517)
1 parent da33a61 commit 5cfba73

8 files changed

Lines changed: 1071 additions & 4 deletions

File tree

config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ params:
3131
go: v1.81.1
3232
java: v1.81.0
3333
node: "@grpc/grpc-js@1.9.0"
34+
rust: v0.9.0
3435
font_awesome_version: 5.12.1
3536
gcs_engine_id: 788f3b1ec3a111a2f
3637
ui:

content/en/_index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Learn more
3232
- [Go]({{< relref "/docs/languages/go/quickstart" >}})
3333
- [C++]({{< relref "/docs/languages/cpp/quickstart" >}})
3434
- [Java]({{< relref "/docs/languages/java/quickstart" >}})
35+
- [Rust]({{< relref "/docs/languages/rust/quickstart" >}})
3536
- [Python]({{< relref "/docs/languages/python/quickstart" >}})
3637
- [<i class="fas fa-ellipsis-h" aria-label="Supported languages"></i>]({{< relref "languages" >}})
3738
</div>
@@ -51,10 +52,10 @@ backend services.
5152
</section>
5253
<div class="youtube-video-center">
5354
<div class="video-wrapper">
54-
<iframe
55-
src="https://www.youtube.com/embed/5dMK5OW6WSw"
56-
title="Ten Years of gRPC"
57-
frameborder="0"
55+
<iframe
56+
src="https://www.youtube.com/embed/5dMK5OW6WSw"
57+
title="Ten Years of gRPC"
58+
frameborder="0"
5859
allowfullscreen>
5960
</iframe>
6061
</div>
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: gRPC-Rust Preview Release
3+
date: 2026-05-28
4+
spelling: cSpell:ignore Tokio
5+
author:
6+
name: Doug Fawley
7+
position: Google
8+
---
9+
10+
Today, the gRPC project is excited to share its first preview release of
11+
gRPC-Rust. It can be found at
12+
[crates.io/crates/grpc](https://crates.io/crates/grpc). Documentation is
13+
available on our website, [grpc.io](https://grpc.io/docs/languages/rust). This
14+
release is not recommended for production use at this time, but is being
15+
released at an early stage to provide Rust programmers with an opportunity to
16+
experiment with the APIs and ensure they will be acceptable for their needs.
17+
18+
## What is included
19+
20+
This release includes:
21+
22+
* **gRPC Client APIs**. Includes all RPC types including unary and streaming.
23+
* gRPC Server support is coming soon.
24+
25+
* **Protobuf support** using Google's [Protobuf-Rust
26+
library](https://github.com/protocolbuffers/protobuf) and tools.
27+
28+
* Messages are generated from Protobuf-Rust via `protoc`.
29+
* gRPC generated RPC code using our `protoc` plugin.
30+
31+
* **Low-level RPC API** for creating interceptors and performing RPCs without
32+
the need for the protobuf generated code.
33+
34+
* Support for the **[Tokio](https://tokio.rs/)** [async
35+
runtime](https://rust-lang.github.io/async-book/08_ecosystem/00_chapter.html#async-runtimes).
36+
* Future gRPC-Rust releases intend to work with any runtime; however, for this
37+
preview we are only targetting Tokio.
38+
39+
## Learn more
40+
41+
Documentation for this gRPC-Rust preview can be found on
42+
[grpc.io](https://grpc.io/docs/languages/rust/). The following resources are
43+
available:
44+
45+
* [Generated code reference](https://grpc.io/docs/languages/rust/generated-code)
46+
* [Quick start guide](https://grpc.io/docs/languages/rust/quickstart)
47+
* [Basics tutorial](https://grpc.io/docs/languages/rust/basics) that covers each
48+
of the four RPC types.
49+
50+
## Contact the team
51+
52+
Please reach out to the team if you have any feedback or encounter any issues:
53+
54+
* Bugs/Feature Requests: [Github Repo](https://github.com/grpc/grpc-rust)
55+
* Discussions: [Google Groups](https://groups.google.com/g/grpc-io)
56+
57+
## Join us at gRPConf 2026!
58+
59+
If you're interested in meeting the gRPC team, discussing related topics with
60+
others in the industry, or maybe even sharing your own experiences or advice in
61+
a talk, please mark your calendar for **Thursday, September 3rd**, when we'll be
62+
holding this year's gRPC developer's conference at the [Computer History
63+
Museum](https://computerhistory.org/) in Mountain View, CA.
64+
65+
* **Event Site:** [gRPConf](https://events.linuxfoundation.org/grpconf/)
66+
* **CFP is open:** [Submit your talk!](https://events.linuxfoundation.org/grpconf/program/cfp/)
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Rust
3+
prog_lang_home: true
4+
api_path: https://docs.rs/grpc
5+
content:
6+
- learn_more:
7+
- "[Examples]($src_repo_url/tree/master/examples)"
8+
- reference:
9+
- "[API](api/)"
10+
- "[Generated code](generated-code/)"
11+
- other:
12+
- $src_repo_link
13+
spelling: cSpell:ignore youtube
14+
---
15+
16+
{{% docs/prog-lang-home-content %}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: API reference
3+
linkTitle: API
4+
weight: 90
5+
# Note: this is a placeholder page. The URL to this page redirects elsewhere.
6+
manualLinkTarget: _blank
7+
_build: { render: link }
8+
---

0 commit comments

Comments
 (0)