#pipe #fifo #filter #threads

runnel

the pluggable io stream. now support: stdio, string io, in memory pipe

23 releases

0.3.17 Feb 12, 2023
0.3.11 Jun 13, 2022
0.3.9 Nov 14, 2021
0.3.7 Jun 24, 2021
0.3.4 Mar 8, 2021

#70 in Concurrency

Download history 128/week @ 2023-10-30 128/week @ 2023-11-06 88/week @ 2023-11-13 111/week @ 2023-11-20 119/week @ 2023-11-27 84/week @ 2023-12-04 72/week @ 2023-12-11 115/week @ 2023-12-18 152/week @ 2023-12-25 45/week @ 2024-01-01 90/week @ 2024-01-08 75/week @ 2024-01-15 82/week @ 2024-01-22 98/week @ 2024-01-29 95/week @ 2024-02-05 178/week @ 2024-02-12

463 downloads per month
Used in 12 crates

MIT/Apache

48KB
1K SLoC

runnel

crate Docs Rust Version Apache2/MIT licensed Test ubu Test mac Test win

The pluggable io stream. now support: stdio, string io, in memory pipe.

Features

  • support common operation: stdin, stdout, stderr, stringin, stringout, pipein and pipeout.
  • thin interface
  • support testing stream io
  • minimum support rustc 1.57.0 (f1edd0429 2021-11-29)

Examples

Example of stdio :

use runnel::RunnelIoeBuilder;
let sioe = RunnelIoeBuilder::new().build();

Example of stringio :

use runnel::RunnelIoeBuilder;
use std::io::{BufRead, Write};

let sioe = RunnelIoeBuilder::new()
    .fill_stringio_with_str("ABCDE\nefgh\n")
    .build();

// pluggable stream in
let mut lines_iter = sioe.pin().lock().lines().map(|l| l.unwrap());
assert_eq!(lines_iter.next(), Some(String::from("ABCDE")));
assert_eq!(lines_iter.next(), Some(String::from("efgh")));
assert_eq!(lines_iter.next(), None);

// pluggable stream out
#[rustfmt::skip]
let res = sioe.pout().lock()
    .write_fmt(format_args!("{}\nACBDE\nefgh\n", 1234));
assert!(res.is_ok());
assert_eq!(sioe.pout().lock().buffer_str(), "1234\nACBDE\nefgh\n");

// pluggable stream err
#[rustfmt::skip]
let res = sioe.perr().lock()
    .write_fmt(format_args!("{}\nACBDE\nefgh\n", 1234));
assert!(res.is_ok());
assert_eq!(sioe.perr().lock().buffer_str(), "1234\nACBDE\nefgh\n");

Example of pipeio :

use runnel::RunnelIoeBuilder;
use runnel::medium::pipeio::pipe;
use std::io::{BufRead, Write};

// create in memory pipe
let (a_out, a_in) = pipe(1);

// a working thread
let sioe = RunnelIoeBuilder::new()
    .fill_stringio_with_str("ABCDE\nefgh\n")
    .pout(a_out)    // pluggable pipe out
    .build();
let handler = std::thread::spawn(move || {
    for line in sioe.pin().lock().lines().map(|l| l.unwrap()) {
        let mut out = sioe.pout().lock();
        let _ = out.write_fmt(format_args!("{}\n", line));
        let _ = out.flush();
    }
});

// a main thread
let sioe = RunnelIoeBuilder::new()
    .fill_stringio_with_str("ABCDE\nefgh\n")
    .pin(a_in)      // pluggable pipe in
    .build();
let mut lines_iter = sioe.pin().lock().lines().map(|l| l.unwrap());
assert_eq!(lines_iter.next(), Some(String::from("ABCDE")));
assert_eq!(lines_iter.next(), Some(String::from("efgh")));
assert_eq!(lines_iter.next(), None);

assert!(handler.join().is_ok());

Changelogs

This crate's changelog here.

License

This project is licensed under either of

at your option.

No runtime deps