Danny HuaandGitHub
1b3d107206
* don't replace extern_path'd paths tonic-build will replace all paths except for google well known types with one rooted at the super module. For paths that have already been replaced with a fully qualified path via the extern_path config option, (e.g. "::uuid::Uuid"), this results in an invalid path (e.g. "super::::uuid::Uuid"), and a build failure. These paths should also be excluded when prefixing relative modules with super. * add doc in tonic-build clarifying extern_path extern_path expects fully qualified proto and rust paths * add test cast case for extern path fix add a test that extern path does indeed result in service types using the specified type from an external crate. we test this by creating a service type that has a proto from a different crate, and asserting that it does indeed impl a trait from that crate * add license/publish to extern_path test crates
A rust implementation of gRPC, a high performance, open source, general RPC framework that puts mobile and HTTP/2 first.
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
Getting Started
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 currently works on rust 1.39 and above as it requires support for the async_await
feature.
$ rustup update
$ rustup component add rustfmt
$ cargo build
Tutorials
- The
helloworldtutorial provides a basic example of usingtonic, perfect for first time users! - The
routeguidetutorial provides a complete example of usingtonicand all its features.
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.examples: Example gRPC implementations showing off tls, load balancing and bi-directional streaming.interop: Interop tests implementation.
Contributing
🎈 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.