Technical Documentation: hyperium/tonic
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (README.md)
A rust implementation of gRPC, a high performance, open source, general
RPC framework that puts mobile and HTTP/2 first.
Note: tonic's master branch is
currently preparing breaking changes. For the most recently released code,
look to the 0.14.x branch.
tonic is a gRPC over HTTP/2 implementation focused on high performance, interoperability, and flexibility. This library was created to have first class support of async/await and to act as a core building block for production systems written in Rust.
Examples | Website | Docs | Chat
Overview
tonic is composed of three main components: the generic gRPC implementation, the high performance HTTP/2
implementation and the codegen powered by prost. The generic implementation can support any HTTP/2
implementation and any encoding via a set of generic traits. The HTTP/2 implementation is based on hyper,
a fast HTTP/1.1 and HTTP/2 client and server built on top of the robust tokio stack. The codegen
contains the tools to build clients and servers from protobuf definitions.
Features
- Bi-directional streaming
- High performance async io
- Interoperability
- TLS backed by
rustls - Load balancing
- Custom metadata
- Authentication
- Health Checking
Getting Started
- The
helloworldtutorial provides a basic example of usingtonic, perfect for first time users! - The
routeguidetutorial provides a complete example of usingtonicand all its features.
Examples can be found in examples and for more complex scenarios interop
may be a good resource as it shows examples of many of the gRPC features.
Rust Version
tonic's MSRV is 1.88.
Dependencies
tonic-build uses protoc Protocol Buffers compiler in some APIs which compile Protocol Buffers resource files such as tonic_build::compile_protos().
Getting Help
First, see if the answer to your question can be found in the API documentation.
If the answer is not there, there is an active community in
the Tonic Discord channel. We would be happy to try to answer your
question. If that doesn't work, try opening an issue with the question.
Project Layout
tonic: Generic gRPC and HTTP/2 client/server implementation.tonic-build:prostbased service codegen.tonic-types:prostbased grpc utility types including support for gRPC Well Known Types.tonic-health: Implementation of the standard gRPC health checking service.
Also serves as an example of both unary and response streaming.tonic-reflection: A tonic based gRPC reflection implementation.examples: Example gRPC implementations showing off tls, load balancing and bi-directional streaming.interop: Interop tests implementation.
Contributing
:balloon: Thanks for your help improving the project! We are so happy to have
you! We have a contributing guide to help you get involved in the Tonic
project.
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Tonic by you, shall be licensed as MIT, without any additional
terms or conditions.
--- METRICS ---
- Files Extracted: 1
- Estimated Token Budget: ~1178 tokens
- Canonical Reference: https://codewiki.google/github.com/hyperium/tonic