README.md

pipelib

Pipelib is a thin Rust wrapper over non-blocking Unix pipes and polling. It is intended to provide an interface more similar to libc's than libraries like mio without sacrificing ergonomics or useful features. It is also very small, having only two dependencies other than libc.

Example

use pipelib::{Event, Poll, Token, Timeout};
use std::{io::{self, prelude::*}, str};

fn main() -> io::Result<()> {
    const READER_TOKEN: Token = Token(0);
    const WRITER_TOKEN: Token = Token(1);
    let (mut reader, mut writer) = pipelib::new()?;
    let mut poll = Poll::new();
    poll.register(&mut reader, READER_TOKEN, Event::POLLIN | Event::POLLERR);
    poll.register(&mut writer, WRITER_TOKEN, Event::POLLOUT | Event::POLLERR);
    let mut buf = Vec::new();
    'outer: loop {
        poll.poll(Timeout::instant())?;
        for (tok, ev) in poll.events() {
            if tok == WRITER_TOKEN && ev.is_writable() {
                writer.write(b"Hello, world")?;
            } else if tok == READER_TOKEN && ev.is_readable() {
                reader.read_to_end(&mut buf)?;
                match str::from_utf8(&buf) {
                    Ok(s) => println!("{}", s),
                    Err(_) => panic!("Invalid unicode"),
                }
                break 'outer;
            }
        }
    }
    Ok(())
}

Compatibility

Pipelib should work on any Unix-like OS and is actively developed and tested on Linux and MacOS. Windows is not supported.