tonic/client/mod.rs
1/*
2 *
3 * Copyright 2025 gRPC authors.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 */
24
25//! Generic client implementation.
26//!
27//! This module contains the low level components to build a gRPC client. It
28//! provides a codec agnostic gRPC client dispatcher and a decorated tower
29//! service trait.
30//!
31//! This client is generally used by some code generation tool to provide stubs
32//! for the gRPC service. Thusly, they are a bit cumbersome to use by hand.
33//!
34//! ## Concurrent usage
35//!
36//! Upon using the your generated client, you will discover all the functions
37//! corresponding to your rpc methods take `&mut self`, making concurrent
38//! usage of the client difficult. The answer is simply to clone the client,
39//! which is cheap as all client instances will share the same channel for
40//! communication. For more details, see
41//! [transport::Channel](../transport/struct.Channel.html#multiplexing-requests).
42
43mod grpc;
44mod service;
45
46pub use self::grpc::Grpc;
47pub use self::service::GrpcService;