Crate varlink[][src]

Server support for the varlink protocol

To create a varlink server in rust, place your varlink interface definition file in src/. E.g. src/org.example.ping.varlink:

# Example service
interface org.example.ping

# Returns the same string
method Ping(ping: string) -> (pong: string)

Then create a build.rs file in your project directory:

This example is not tested
extern crate varlink;

fn main() {
    varlink::generator::cargo_build_tosource("src/org.example.ping.varlink",
                                             /* rustfmt */ true);
}

Add to your Cargo.toml:

[package]
build = "build.rs"

In your main.rs you can then use:

This example is not tested
mod org_example_ping;

and then implement the interface:

struct MyOrgExamplePing;

impl VarlinkInterface for MyOrgExamplePing {
    fn ping(&self, call: &mut Call_Ping, ping: String) -> Result<()> {
        return call.reply(ping);
    }
}

to implement the interface methods.

If your varlink method is called TestMethod, the rust method to be implemented is called test_method. The first parameter is of type Call_TestMethod, which has the method reply().

fn test_method(&self, call: &mut Call_TestMethod, /* more arguments */) -> Result<()> {
    /* ... */
    return call.reply( /* more arguments */ );
}

A typical server creates a VarlinkService and starts a server via varlink::listen()

let args: Vec<_> = std::env::args().collect();
let myorgexampleping = MyOrgExamplePing;
let myorgexampleping_interface = org_example_ping::new(Box::new(myorgexampleping));

let service = varlink::VarlinkService::new(
    "org.varlink",
    "test service",
    "0.1",
    "http://varlink.org",
    vec![
        Box::new(myorgexampleping_interface),
    ], // more interfaces ...
);

varlink::listen(service, &args[1], 10, 0);

where args[1] would follow the varlink address specification.

Currently supported address URIs are:

Modules

generator

Generate rust code from varlink interface definition files

Structs

Call

Call is a struct, which is passed as the first argument to the interface methods in a derived form.

Connection
Error
ErrorInterfaceNotFound
ErrorInvalidParameter
ErrorMethodNotFound
ErrorMethodNotImplemented
GetInfoArgs
GetInterfaceDescriptionArgs
GetInterfaceDescriptionReply
MethodCall
OrgVarlinkServiceClient
Reply

The structure of a varlink reply. Used to deserialize it into json.

Request

The structure of a varlink request. Used to serialize json into it.

ServiceInfo
StringHashSet
VarlinkService

VarlinkService handles all the I/O and dispatches method calls to the registered interfaces.

Enums

ErrorKind

Traits

CallTrait

CallTrait provides convenience methods for the Call struct, which is passed as the first argument to the interface methods.

Interface

This trait has to be implemented by any varlink interface implementor. All methods are generated by the varlink-rust-generator, so you don't have to care about them.

OrgVarlinkServiceInterface
VarlinkReply

Marker trait for the rust code generated by the varlink-rust-generator

Functions

listen

listen creates a server, with num_worker threads listening on varlink_uri.

Type Definitions

Result
StringHashMap