diff options
Diffstat (limited to 'third_party/rust/mio-uds/README.md')
| -rw-r--r-- | third_party/rust/mio-uds/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/third_party/rust/mio-uds/README.md b/third_party/rust/mio-uds/README.md new file mode 100644 index 0000000000..ebbaa706bf --- /dev/null +++ b/third_party/rust/mio-uds/README.md @@ -0,0 +1,49 @@ +# mio-uds + +A library for integrating Unix Domain Sockets with [mio]. Based on the standard +library's [support for Unix sockets][std], except all of the abstractions and +types are nonblocking to conform with the expectations of mio. + +[mio]: https://github.com/tokio-rs/mio +[std]: https://doc.rust-lang.org/std/os/unix/net/ + +[](https://github.com/deprecrated/mio-uds/actions?query=workflow%3ACI+branch%3Amaster) +[](https://docs.rs/mio-uds/~0.6) + +# mio-uds is Deprecated + +With the 0.7 release, `mio` now includes native support for Unix Domain +Sockets. Consumers should switch to that functionality when updating their +`mio` dependency to the 0.7.x series. + + +## Usage + +```toml +# Cargo.toml +[dependencies] +mio-uds = "0.6" +mio = "0.6" +``` + +The three exported types at the top level, `UnixStream`, `UnixListener`, and +`UnixDatagram`, are thin wrappers around the libstd counterparts. They can be +used in similar fashions to mio's TCP and UDP types in terms of registration and +API. + +# License + +This project is licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. |