使用方法

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

tarpc = "0.18.0"

tarpc::service属性会扩展为一个由组成RPC服务的项目集合。这些生成的类型使得编写服务器变得更加容易和舒适。只需实现生成的服务特质，然后你就可以开始了！

示例

对于这个示例，除了tarpc，还需要在Cargo.toml中添加两个其他依赖项

futures-preview = "0.3.0-alpha.18"
tokio = "0.2.0-alpha.3"

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

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

use futures::{
    future::{self, Ready},
    prelude::*,
};
use tarpc::{
    client, context,
    server::{self, Handler},
};
use std::io;

// 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还提供了一个使用TCP上的bincode的传输。

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

    let server = server::new(server::Config::default())
        // incoming() takes a stream of transports such as would be returned by
        // TcpListener::incoming (but a stream instead of an iterator).
        .incoming(stream::once(future::ready(server_transport)))
        .respond_with(HelloServer.serve());

    tokio::spawn(server);

    // WorldClient is generated by the macro. 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