使用方法

将依赖项添加到您的Cargo.toml

tarpc = "0.31"

tarpc::service属性扩展为一个集合，该集合形成了一个RPC服务。这些生成的类型使得编写服务器变得简单且易于使用，减少了样板代码。只需实现生成的服务特性和，然后您就可以开始比赛了！

示例

此示例使用tokio，因此请将以下依赖项添加到您的Cargo.toml

anyhow = "1.0"
futures = "0.3"
tarpc = { version = "0.31", features = ["tokio1"] }
tokio = { version = "1.0", features = ["macros"] }

在以下示例中，我们使用进程内通道进行客户端和服务器之间的通信。在实际代码中，您可能会通过网络进行通信。有关更实际的示例，请参阅example-service。

首先，让我们设置依赖项和服务定义。

use futures::{
    future::{self, Ready},
    prelude::*,
};
use tarpc::{
    client, context,
    server::{self, incoming::Incoming, Channel},
};

// This is the service definition. It looks a lot like a trait definition.
// It defines one RPC, hello, which takes one arg, name, and returns a String.
#[tarpc::service]
trait World {
    /// Returns a greeting for name.
    async fn hello(name: String) -> String;
}

此服务定义生成一个名为World的特性和。接下来，我们需要为我们的Server结构体实现它。

// This is the type that implements the generated World trait. It is the business logic
// and is used to start the server.
#[derive(Clone)]
struct HelloServer;

impl World for HelloServer {
    // Each defined rpc generates two items in the trait, a fn that serves the RPC, and
    // an associated type representing the future output by the fn.

    type HelloFut = Ready<String>;

    fn hello(self, _: context::Context, name: String) -> Self::HelloFut {
        future::ready(format!("Hello, {name}!"))
    }
}

最后，让我们编写我们的main，它将启动服务器。虽然此示例使用进程内通道，但tarpc还提供了一个在serde-transport功能背后的通用serde_transport，以及额外的TCP功能，在tcp功能背后可用。

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let (client_transport, server_transport) = tarpc::transport::channel::unbounded();

    let server = server::BaseChannel::with_defaults(server_transport);
    tokio::spawn(server.execute(HelloServer.serve()));

    // WorldClient is generated by the #[tarpc::service] attribute. It has a constructor `new`
    // that takes a config and any Transport as input.
    let mut client = WorldClient::new(client::Config::default(), client_transport).spawn();

    // The client has an RPC method for each RPC defined in the annotated trait. It takes the same
    // args as defined, with the addition of a Context, which is always the first arg. The Context
    // specifies a deadline and trace information which can be helpful in debugging requests.
    let hello = client.hello(context::current(), "Stim".to_string()).await?;

    println!("{hello}");

    Ok(())
}

服务文档

使用您通常使用的cargo doc来查看由service!调用扩展的所有项创建的文档。

许可：MIT