thrift/
lib.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Rust runtime library for the Apache Thrift RPC system.
19//!
20//! This crate implements the components required to build a working
21//! Thrift server and client. It is divided into the following modules:
22//!
23//! 1. errors
24//! 2. configuration
25//! 3. protocol
26//! 4. transport
27//! 5. server
28//! 6. autogen
29//!
30//! The modules are layered as shown in the diagram below. The `autogen'd`
31//! layer is generated by the Thrift compiler's Rust plugin. It uses the
32//! types and functions defined in this crate to serialize and deserialize
33//! messages and implement RPC. Users interact with these types and services
34//! by writing their own code that uses the auto-generated clients and
35//! servers.
36//!
37//! ```text
38//! +-----------+
39//! | user app  |
40//! +-----------+
41//! | autogen'd | (uses errors, autogen)
42//! +-----------+
43//! |  protocol |
44//! +-----------+
45//! | transport |
46//! +-----------+
47//! ```
48//!
49//! # Tutorial
50//!
51//! For an example of how to setup a simple client and server using this crate
52//! see the [tutorial].
53//!
54//! [tutorial]: https://github.com/apache/thrift/tree/master/tutorial/rs
55
56#![crate_type = "lib"]
57#![doc(test(attr(allow(unused_variables, dead_code), deny(warnings))))]
58#![deny(bare_trait_objects)]
59
60// NOTE: this macro has to be defined before any modules. See:
61// https://danielkeep.github.io/quick-intro-to-macros.html#some-more-gotchas
62
63/// Assert that an expression returning a `Result` is a success. If it is,
64/// return the value contained in the result, i.e. `expr.unwrap()`.
65#[cfg(test)]
66macro_rules! assert_success {
67    ($e: expr) => {{
68        let res = $e;
69        assert!(res.is_ok());
70        res.unwrap()
71    }};
72}
73
74pub mod protocol;
75
76#[cfg(feature = "server")]
77pub mod server;
78pub mod transport;
79
80mod errors;
81pub use crate::errors::*;
82
83mod autogen;
84pub use crate::autogen::*;
85
86mod configuration;
87pub use crate::configuration::*;
88
89/// Result type returned by all runtime library functions.
90///
91/// As is convention this is a typedef of `std::result::Result`
92/// with `E` defined as the `thrift::Error` type.
93pub type Result<T> = std::result::Result<T, self::Error>;
94
95// Re-export ordered-float, since it is used by the generator
96// FIXME: check the guidance around type reexports
97pub use ordered_float::OrderedFloat;
thrift/lib.rs

thrift/
lib.rs
