mio-named-pipes

Crates.iomio-named-pipes
lib.rsmio-named-pipes
version0.1.7
sourcesrc
created_at2016-12-18 19:10:22.843104
updated_at2020-06-30 14:39:34.813841
descriptionWindows named pipe bindings for mio
homepagehttps://github.com/bbqsrc/mio-named-pipes
repositoryhttps://github.com/bbqsrc/mio-named-pipes
max_upload_size
id7663
size52,856
Brendan Molloy (bbqsrc)

documentation

https://docs.rs/mio-named-pipes/

README

mio-named-pipes

Run tests

Documentation

A library for integrating Windows Named Pipes with mio.

# Cargo.toml
[dependencies]
mio-named-pipes = "0.1"
mio = "0.6"

Usage

The primary type, NamedPipe, can be constructed with NamedPipe::new or through the IntoRawHandle type. All operations on NamedPipe are nonblocking and will return an I/O error if they'd block (with the error indicating so).

Typically you can use a NamedPipe in the same way you would a TCP socket on Windows with mio.

Note: Named pipes on Windows do not have a zero-cost abstraction when working with the mio interface (readiness, not completion). As a result, this library internally has some buffer management that hasn't been optimized yet. It's recommended you benchmark this library for your application, and feel free to contact me if anything looks awry.

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in mio-named-pipes by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 45

cargo fmt