Crate doors

source ·
Expand description

A Rust-friendly interface for illumos Doors.

Doors are a high-speed, RPC-style interprocess communication facility for the illumos operating system. They enable rapid dialogue between client and server without giving up the CPU timeslice, and are an excellent alternative to pipes or UNIX domain sockets in situations where IPC latency matters.

This crate makes it easier to interact with the Doors API from Rust. It can help you create clients, define server procedures, and open or create doors on the filesystem.

Example

// In the Server --------------------------------------- //
use doors::server::Door;
use doors::server::Request;
use doors::server::Response;

#[doors::server_procedure]
fn double(x: Request) -> Response<[u8; 1]> {
  if x.data.len() > 0 {
    return Response::new([x.data[0] * 2]);
  } else {
    // We were given nothing, and 2 times nothing is zero...
    return Response::new([0]);
  }
}

let door = Door::create(double).unwrap();
door.force_install("/tmp/double.door").unwrap();

// In the Client --------------------------------------- //
use doors::Client;

let client = Client::open("/tmp/double.door").unwrap();

let response = client.call_with_data(&[111]).unwrap();
assert_eq!(response.data()[0], 222);

Modules

  • illumos
    illumos-specific APIs not (yet) found in the libc crate
  • server
    Traits for easier Server Procedures

Structs

  • Client
    Less unsafe door client (compared to raw file descriptors)

Enums

Attribute Macros

  • server_procedure
    This macro transforms a Rust function into a Doors-compatible server procedure.