Crate capnp_rpc

Expand description

An implementation of the Cap’n Proto remote procedure call protocol. Includes all Level 1 features.

Example

# Cap'n Proto schema
interface Foo {
    identity @0 (x: UInt32) -> (y: UInt32);
}

// Rust server defining an implementation of Foo.
struct FooImpl;
impl foo::Server for FooImpl {
    fn identity(&mut self,
                params: foo::IdentityParams,
                mut results: foo::IdentityResults)
                -> Promise<(), ::capnp::Error>
    {
        let x = pry!(params.get()).get_x();
        results.get().set_y(x);
        Promise::ok(())
    }
}

// Rust client calling a remote implementation of Foo.
let mut request = foo_client.identity_request();
request.get().set_x(123);
let promise = request.send().promise.and_then(|response| {
    println!("results = {}", response.get()?.get_y());
    Ok(())
});

For a more complete example, see https://github.com/capnproto/capnproto-rust/tree/master/capnp-rpc/examples/calculator

Modules

rpc_capnp

Code generated from rpc.capnp.

rpc_twoparty_capnp

Code generated from rpc-twoparty.capnp.

twoparty

An implementation of VatNetwork for the common case of a client-server connection.

Macros

pry

Like try!(), but for functions that return a Promise<T, E> rather than a Result<T, E>.

Structs

CapabilityServerSet

Allows a server to recognize its own capabilities when passed back to it, and obtain the underlying Server objects associated with them.

Disconnector

A Future that can be run to disconnect an RpcSystem’s ConnectionState and wait for it to be closed.

ImbuedMessageBuilder

RpcSystem

A portal to objects available on the network.

Traits

Functions

new_client

Creates a new local RPC client of type C out of an object that implements a server trait S.

new_promise_client

Converts a promise for a client into a client that queues up any calls that arrive before the promise resolves.