Struct doors::Client

pub struct Client(_);

Less unsafe door client (compared to raw file descriptors)

Clients are automatically closed when they go out of scope. Errors detected on closing are ignored by the implementation of Drop, just like in File.

Implementations

impl Client

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a door client like you would a file

pub fn call(&self, arg: DoorArgument) -> Result<DoorArgument, DoorCallError>

Issue a door call

You are responsible for managing this memory. See DOOR_CALL(3C). Particularly, if, after a door_call, the rbuf property of door_arg_t is different than what it was before the door_call, you are responsible for reclaiming this area with MUNMAP(2) when you are done with it.

This crate cannot yet handle this for you. See Issue #11.

pub fn call_with_data(&self, data: &[u8]) -> Result<DoorArgument, DoorCallError>

Issue a door call with Data only

Example

use doors::Client;
use std::ffi::CString;
use std::ffi::CStr;

let capitalize = Client::open("/tmp/barebones_capitalize.door")
    .unwrap();
let text = CString::new("Hello, World!").unwrap();
let response = capitalize.call_with_data(text.as_bytes()).unwrap();
let caps = unsafe {
    CStr::from_ptr(response.data().as_ptr() as *const i8)
};
assert_eq!(caps.to_str(), Ok("HELLO, WORLD!"));

Trait Implementations

impl Drop for Client

fn drop(&mut self)

Automatically close the door on your way out.

This will close the file descriptor associated with this door, so that this process will no longer be able to call this door. For that reason, it is a programming error to Clone this type.

impl FromRawFd for Client

unsafe fn from_raw_fd(raw: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.