33 unstable releases

0.16.1 Mar 29, 2024
0.15.0 Jun 30, 2023
0.14.3 Mar 29, 2023
0.14.2 Dec 22, 2022
0.3.0 Mar 5, 2021

#413 in Rust patterns

Download history 5/week @ 2023-12-24 54/week @ 2024-01-07 1/week @ 2024-01-14 149/week @ 2024-02-25 4/week @ 2024-03-03 15/week @ 2024-03-10 113/week @ 2024-03-24 558/week @ 2024-03-31

686 downloads per month
Used in 2 crates




Unbuffered and unlocked I/O streams

Github Actions CI Status crates.io page docs.rs docs

This crate defines StreamReader, StreamWriter, and StreamDuplexer types which provide safe, owning, unbuffered, and unlocked access to a raw I/O stream, such as standard input, standard output, files, sockets, pipes, or character devices. It also supports a "piped thread" concept, where an arbitrary Box<dyn Read + Send> or Box<dyn Write + Send> can be provided, and the I/O is performed on a thread and connecting to the StreamReader or StreamWriter with a pipe, and a "socketed thread" concept, where a provided function is called on a thread and connected to the main thread via a bidirectional socket.

This crate also defines AsyncStreamReader, AsyncStreamWriter, and AsyncStreamDuplexer, which are async functions that work with async-std. And TokioStreamReader, TokioStreamWriter, and TokioStreamDuplexer, which are async functions that work with tokio. Not all features are supported yet, and they aren't fully optimized yet, but basic file and socket support is in place.

On Posix-ish platforms, including limited support for WASI, these types just contain a single file descriptor (and implement AsFd), plus any resources needed to safely hold the file descriptor live. On Windows, they contain an enum holding either RawHandle or RawSocket.

Since these types are unbuffered, it's advisable for most use cases to wrap them in buffering types such as std::io::BufReader, std::io::BufWriter, std::io::LineWriter, io_streams::BufDuplexer, or io_streams::BufReaderLineWriter.

Rust's std::io::Stdin and std::io::Stdout are always buffered, while its std::fs::File and std::net::TcpStream are unbuffered. A key purpose of the io_streams crate is to abstract over the underlying inputs and outputs without adding buffering, so that buffering can be applied without redundancy.

This crate locks stdio::io::Stdin and std::io::Stdout while it has their corresponding streams open, to prevent accidental mixing of buffered and unbuffered output on the same stream. Attempts to use the buffered streams when they are locked will block indefinitely.

Support for async-std and tokio in char-device and socketpair is temporarily disabled until those crates contain the needed implementations of the I/O safety traits.


~169K SLoC