gecko-dev/third_party/rust/mio-named-pipes
Matthew Gregan 3bc23059fe Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin
Differential Revision: https://phabricator.services.mozilla.com/D22154

--HG--
extra : moz-landing-system : lando
2019-03-07 02:04:54 +00:00
..
src Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
tests Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
.cargo-checksum.json Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
Cargo.toml Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
LICENSE-APACHE Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
LICENSE-MIT Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
README.md Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00
appveyor.yml Bug 1512445 - Re-vendor Rust dependencies for AudioIPC. r=chunmin 2019-03-07 02:04:54 +00:00

README.md

mio-named-pipes

Build status

Documentation

A library for integrating Windows Named Pipes with mio.

# Cargo.toml
[dependencies]
mio-named-pipes = "0.6"
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

mio-named-pipes is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.