1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

//! Rift: Thrift implementation library for Rust.
//!
//! This crate implements the components required to build a working
//! Thrift server and client. It is divided into the following modules:
//!
//! 1. errors
//! 2. protocol
//! 3. transport
//! 4. server
//! 5. autogen
//!
//! The modules are layered as shown. The `generated` layer is code
//! generated by the Thrift compiler's Rust plugin. It uses the components
//! defined in this crate to serialize and deserialize types and implement
//! RPC. Users interact with these types and services by writing their own
//! code on top.
//!
//! ```text
//! +-----------+
//! |  app dev  |
//! +-----------+
//! | generated | <-> errors/results
//! +-----------+
//! |  protocol |
//! +-----------+
//! | transport |
//! +-----------+
//! ```

#![crate_type = "lib"]

extern crate byteorder;
extern crate integer_encoding;
extern crate try_from;

#[macro_use]
extern crate log;

pub mod protocol;
pub mod server;
pub mod transport;

mod errors;
pub use errors::*;

mod autogen;
pub use autogen::*;

/// Result type returned by all rift functions.
///
/// As is convention this is a typedef of `std::result::Result`
/// with `E` defined as the `rift::Error` type.
pub type Result<T> = std::result::Result<T, self::Error>;