Rust Thrift库

概述

此crate实现了构建工作Thrift服务器和客户端所需的组件。它分为以下模块

1. errors
2. protocol
3. transport
4. server
5. autogen

模块按如下分层。生成的generated层是Thrift编译器的Rust插件生成的代码。它使用此crate中定义的组件来序列化和反序列化类型并实现RPC。用户通过编写自己的代码与这些类型和服务交互。

+-----------+
|  app dev  |
+-----------+
| generated | <-> errors/results
+-----------+
|  protocol |
+-----------+
| transport |
+-----------+

使用此crate

将thrift = "x.y.z"添加到您的Cargo.toml中，其中x.y.z是您使用的Thrift编译器的版本。

API文档

完整的Rustdoc

兼容性

Rust库和自动生成的代码针对Rust版本1.28+。它目前不使用任何Rust 2021特性。

重大变更

重大变更已最小化。当它们发生时，将在下面概述并附带过渡指南。

Thrift 0.15.0

• [THRIFT-5360] - 不再为Error类型定义或生成description()方法。

  Error.description()在1.27中已软弃用，并在1.41中弃用。库错误类型也不实现Error.description()。此外，由于此更改，生成的Rust表示的错误不再实现Error.description()方法。相反，它生成一个包含相同信息的Display实现。

  例如

  exception Xception {
    1: i32 errorCode,
    2: string message
  }
  

  以前生成

  use std::error::Error;
  use std::fmt;
  use std::fmt::{Display, Formatter};
  
  // auto-generated by the Thrift compiler
  #[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
  pub struct Xception {
    pub error_code: Option<i32>,
    pub message: Option<String>,
  }
  
  // auto-generated by the Thrift compiler
  impl Error for Xception {
    fn description(&self) -> &str {
      "remote service threw Xception"
    }
  }
  
  // auto-generated by the Thrift compiler
  impl From<Xception> for thrift::Error {
    fn from(e: Xception) -> Self {
      thrift::Error::User(Box::new(e))
    }
  }
  
  // auto-generated by the Thrift compiler
  impl Display for Xception {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
      self.description().format(f)
    }
  }
  

  现在生成

  use std::error::Error;
  use std::fmt;
  use std::fmt::{Display, Formatter};
  
  // auto-generated by the Thrift compiler
  #[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
  pub struct Xception {
    pub error_code: Option<i32>,
    pub message: Option<String>,
  }
  
  // auto-generated by the Thrift compiler
  impl Error for Xception { }
  
  // auto-generated by the Thrift compiler
  impl From<Xception> for thrift::Error {
    fn from(e: Xception) -> Self {
      thrift::Error::User(Box::new(e))
    }
  }
  
  // auto-generated by the Thrift compiler
  impl Display for Xception {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
      write!(f, "remote service threw Xception")
    }
  }
  

• [THRIFT-5314] - 生成向前兼容的枚举实现（即对未知值不报错）

  由于此更改，Rust枚举的表示从标准Rust枚举更改为具有关联常量的newtype结构体。

  例如

    // THRIFT
    enum Operation {
      ADD,
      SUBTRACT,
      MULTIPLY,
      DIVIDE,
    }
  

  以前生成

    // OLD AUTO-GENERATED RUST
    pub enum Operation {
       Add,
       Subtract,
       Multiply,
       Divide,
     }
  

  现在生成

    // NEW AUTO-GENERATED RUST
    pub struct Operation(pub i32);
  
    impl Operation {
      pub const ADD: Operation = Operation(0);
      pub const SUBTRACT: Operation = Operation(1);
      pub const MULTIPLY: Operation = Operation(2);
      pub const DIVIDE: Operation = Operation(3);
    }