gorealis v2 refactor (#5)
* Changing default timeout for start maintenance. * Upgrading dependencies to gorealis v2 and thrift 0.12.0 * Refactored to update to gorealis v2.
This commit is contained in:
parent
ad4dd9606e
commit
6ab5c9334d
1335 changed files with 137431 additions and 61530 deletions
111
vendor/git.apache.org/thrift.git/lib/rs/README.md
generated
vendored
Normal file
111
vendor/git.apache.org/thrift.git/lib/rs/README.md
generated
vendored
Normal file
|
@ -0,0 +1,111 @@
|
|||
# Rust Thrift library
|
||||
|
||||
## Overview
|
||||
|
||||
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 |
|
||||
+-----------+
|
||||
```
|
||||
|
||||
## Using this crate
|
||||
|
||||
Add `thrift = "x.y.z"` to your `Cargo.toml`, where `x.y.z` is the version of the
|
||||
Thrift compiler you're using.
|
||||
|
||||
## API Documentation
|
||||
|
||||
Full [Rustdoc](https://docs.rs/thrift/)
|
||||
|
||||
## Compatibility
|
||||
|
||||
The Rust library and auto-generated code targets Rust versions 1.28+.
|
||||
It does not currently use any Rust 2018 features.
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
Breaking changes are minimized. When they are made they will be outlined below with transition guidelines.
|
||||
|
||||
##### Thrift 0.12.0
|
||||
|
||||
* **[THRIFT-4529]** - Rust enum variants are now camel-cased instead of uppercased to conform to Rust naming conventions
|
||||
|
||||
Previously, enum variants were uppercased in the auto-generated code.
|
||||
For example, the following thrift enum:
|
||||
|
||||
```thrift
|
||||
// THRIFT
|
||||
enum Operation {
|
||||
ADD,
|
||||
SUBTRACT,
|
||||
MULTIPLY,
|
||||
DIVIDE,
|
||||
}
|
||||
```
|
||||
|
||||
used to generate:
|
||||
|
||||
```rust
|
||||
// OLD AUTO-GENERATED RUST
|
||||
pub enum Operation {
|
||||
ADD,
|
||||
SUBTRACT,
|
||||
MULTIPLY,
|
||||
DIVIDE,
|
||||
}
|
||||
```
|
||||
It *now* generates:
|
||||
```rust
|
||||
// NEW AUTO-GENERATED RUST
|
||||
pub enum Operation {
|
||||
Add,
|
||||
Subtract,
|
||||
Multiply,
|
||||
Divide,
|
||||
}
|
||||
```
|
||||
|
||||
You will have to change all enum variants in your code to use camel-cased names.
|
||||
This should be a search and replace.
|
||||
|
||||
## Contributing
|
||||
|
||||
Bug reports and PRs are always welcome! Please see the
|
||||
[Thrift website](https://thrift.apache.org/) for more details.
|
||||
|
||||
Thrift Rust support requires code in several directories:
|
||||
|
||||
* `compiler/cpp/src/thrift/generate/t_rs_generator.cc`: binding code generator
|
||||
* `lib/rs`: runtime library
|
||||
* `lib/rs/test`: supplemental tests
|
||||
* `tutorial/rs`: tutorial client and server
|
||||
* `test/rs`: cross-language test client and server
|
||||
|
||||
All library code, test code and auto-generated code compiles and passes clippy
|
||||
without warnings. All new code must do the same! When making changes ensure that:
|
||||
|
||||
* `rustc` does does output any warnings
|
||||
* `clippy` with default settings does not output any warnings (includes auto-generated code)
|
||||
* `cargo test` is successful
|
||||
* `make precross` and `make check` are successful
|
||||
* `tutorial/bin/tutorial_client` and `tutorial/bin/tutorial_server` communicate
|
Loading…
Add table
Add a link
Reference in a new issue