3 releases

0.1.2 Mar 29, 2023
0.1.1 Oct 8, 2022
0.1.0 Oct 8, 2022

#677 in Asynchronous

25 downloads per month

MIT/Apache

39KB
804 lines

Pirates!

pirate Rust ArrrrPC Lib

CI docs Current Crates.io Version

Pirates, a simple and straightforward interface for serving and calling RPCs from async rust programs

Define an RPC

    pub struct AddName {}
    #[pirates::rpc_definition]
    impl AddName {
        fn name() -> RpcId {
            RpcId::AddName
        }
        fn implement(state: &mut ServerState, query: String) -> RpcResult<()> {
            state.names.push(query);
            Ok(())
        }
    }

Serve it

    let mut server = RpcServer::new(state.clone());
    server.add_rpc(Box::new(rpcs::AddName::server()));

Call it

    let addr = "200.1.3.7:5959";
    let name = String::from("Gaspode the wonder dog");
    pirates::call_client(addr, name, rpcs::AddName::client()).await;

    let names = call_client(addr, (), rpcs::GetNames::client()).await;
    assert_eq!(vec![String::from("Gaspode the wonder dog")], names);

Documentation

Documentation available on docs.rs

Examples

And example "name server" is available in example/. This produces a CLI binary from which you can host the server and then query it separately to add and print names. See the README in that directory for more info

TODO

  • More examples?

License

Apache-2.0 Or MIT

Dependencies

~4–12MB
~133K SLoC