1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
/*!
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 :
```rust
use runnel::RunnelIoeBuilder;
let sioe = RunnelIoeBuilder::new().build();
```
## Example of stringio :
```rust
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 :
```rust
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());
```
*/
pub mod medium;
use std::borrow::Borrow;
use std::fmt::Debug;
use std::io::{BufRead, Read, Result, Write};
use std::panic::{RefUnwindSafe, UnwindSafe};
//----------------------------------------------------------------------
/// A stream in
pub trait StreamIn: Send + Sync + UnwindSafe + RefUnwindSafe + Debug {
fn lock(&self) -> Box<dyn StreamInLock + '_>;
}
impl Read for &dyn StreamIn {
fn read(&mut self, buf: &mut [u8]) -> Result<usize> {
self.lock().read(buf)
}
}
/// A locked reference to `StreamIn`
pub trait StreamInLock: Read + BufRead {}
/// A stream out
pub trait StreamOut: Send + Sync + UnwindSafe + RefUnwindSafe + Debug {
fn lock(&self) -> Box<dyn StreamOutLock + '_>;
}
impl Write for &dyn StreamOut {
fn write(&mut self, buf: &[u8]) -> Result<usize> {
self.lock().write(buf)
}
fn flush(&mut self) -> Result<()> {
self.lock().flush()
}
}
/// A locked reference to `StreamOut`
pub trait StreamOutLock: Write {
fn buffer(&self) -> &[u8];
fn buffer_str(&mut self) -> &str;
}
/// A stream err
pub trait StreamErr: Send + Sync + UnwindSafe + RefUnwindSafe + Debug {
fn lock(&self) -> Box<dyn StreamErrLock + '_>;
}
impl Write for &dyn StreamErr {
fn write(&mut self, buf: &[u8]) -> Result<usize> {
self.lock().write(buf)
}
fn flush(&mut self) -> Result<()> {
self.lock().flush()
}
}
/// A locked reference to `StreamErr`
pub trait StreamErrLock: Write {
fn buffer(&self) -> &[u8];
fn buffer_str(&mut self) -> &str;
}
//----------------------------------------------------------------------
/// The set of `StreamIn`, `StreamOut`, `StreamErr`.
#[derive(Debug)]
pub struct RunnelIoe {
pin: Box<dyn StreamIn>,
pout: Box<dyn StreamOut>,
perr: Box<dyn StreamErr>,
}
impl RunnelIoe {
/// create RunnelIoe. use [RunnelIoeBuilder].
pub fn new(
a_in: Box<dyn StreamIn>,
a_out: Box<dyn StreamOut>,
a_err: Box<dyn StreamErr>,
) -> RunnelIoe {
RunnelIoe {
pin: a_in,
pout: a_out,
perr: a_err,
}
}
/// get pluggable stream in
pub fn pin(&self) -> &dyn StreamIn {
self.pin.borrow()
}
/// get pluggable stream out
pub fn pout(&self) -> &dyn StreamOut {
self.pout.borrow()
}
/// get pluggable stream err
pub fn perr(&self) -> &dyn StreamErr {
self.perr.borrow()
}
}
/// The builder for RunnelIoe
///
/// # Examples
///
/// ## Example: fill stdio
///
/// build RunnelIoe has [std::io::stdin()], [std::io::stdout()], [std::io::stderr()],
///
/// ```rust
/// use runnel::RunnelIoeBuilder;
/// let sioe = RunnelIoeBuilder::new().build();
/// ```
///
/// ## Example: fill stringio
///
/// build RunnelIoe has [medium::stringio::StringIn],
/// [medium::stringio::StringOut], [medium::stringio::StringErr],
///
/// ```rust
/// use runnel::RunnelIoeBuilder;
/// use runnel::medium::stringio::{StringIn, StringOut, StringErr};
/// let sioe = RunnelIoeBuilder::new()
/// .pin(StringIn::with_str("abcdefg"))
/// .pout(StringOut::default())
/// .perr(StringErr::default())
/// .build();
/// ```
///
/// ## Example: fill stringio by fill_stringio_with_str()
///
/// build RunnelIoe has [medium::stringio::StringIn],
/// [medium::stringio::StringOut], [medium::stringio::StringErr],
///
/// ```rust
/// use runnel::RunnelIoeBuilder;
/// let sioe = RunnelIoeBuilder::new()
/// .fill_stringio_with_str("abcdefg")
/// .build();
/// ```
///
/// ## Example: stdio and pipe
///
/// This case is multi-threads.
/// read stdin on working thread, write stdout on main thread.
/// The data is through in-memory [pipe].
///
/// [pipe]: medium::pipeio::pipe
///
/// ```rust
/// use runnel::RunnelIoeBuilder;
/// use runnel::medium::pipeio::pipe;
/// use std::io::{BufRead, Write};
///
/// fn run() -> std::io::Result<()> {
/// let (a_out, a_in) = pipe(1);
///
/// // a working thread
/// #[rustfmt::skip]
/// let sioe = RunnelIoeBuilder::new().pout(a_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();
/// out.write_fmt(format_args!("{}\n", line)).unwrap();
/// out.flush().unwrap();
/// }
/// });
///
/// // a main thread
/// #[rustfmt::skip]
/// let sioe = RunnelIoeBuilder::new().pin(a_in).build();
/// for line in sioe.pin().lock().lines() {
/// let line_s = line?;
/// let mut out = sioe.pout().lock();
/// out.write_fmt(format_args!("{}\n", line_s))?;
/// out.flush()?;
/// }
/// Ok(())
/// }
/// ```
///
#[derive(Debug)]
pub struct RunnelIoeBuilder {
pin: Option<Box<dyn StreamIn>>,
pout: Option<Box<dyn StreamOut>>,
perr: Option<Box<dyn StreamErr>>,
}
impl RunnelIoeBuilder {
/// create builder
pub fn new() -> Self {
RunnelIoeBuilder {
pin: None,
pout: None,
perr: None,
}
}
/// set pluggable stream in
pub fn pin<T: 'static + StreamIn>(mut self, a: T) -> Self {
self.pin = Some(Box::new(a));
self
}
/// set pluggable stream out
pub fn pout<T: 'static + StreamOut>(mut self, a: T) -> Self {
self.pout = Some(Box::new(a));
self
}
/// set pluggable stream err
pub fn perr<T: 'static + StreamErr>(mut self, a: T) -> Self {
self.perr = Some(Box::new(a));
self
}
/// build to RunnelIoe
pub fn build(self) -> RunnelIoe {
let a_in = if let Some(a) = self.pin {
a
} else {
Box::<medium::stdio::StdIn>::default()
};
let a_out = if let Some(a) = self.pout {
a
} else {
Box::<medium::stdio::StdOut>::default()
};
let a_err = if let Some(a) = self.perr {
a
} else {
Box::<medium::stdio::StdErr>::default()
};
//
RunnelIoe::new(a_in, a_out, a_err)
}
/// fill with stringio, arg as input
pub fn fill_stringio_with_str(self, arg: &str) -> Self {
use crate::medium::stringio::*;
self.pin(StringIn::with_str(arg))
.pout(StringOut::default())
.perr(StringErr::default())
}
/// fill with stringio, arg as input
pub fn fill_stringio(self, arg: String) -> Self {
use crate::medium::stringio::*;
self.pin(StringIn::with(arg))
.pout(StringOut::default())
.perr(StringErr::default())
}
}
impl Default for RunnelIoeBuilder {
fn default() -> Self {
Self::new()
}
}