diff options
Diffstat (limited to 'third_party/rust/memmap/README.md')
-rw-r--r-- | third_party/rust/memmap/README.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/third_party/rust/memmap/README.md b/third_party/rust/memmap/README.md new file mode 100644 index 0000000000..c230b32062 --- /dev/null +++ b/third_party/rust/memmap/README.md @@ -0,0 +1,53 @@ +# memmap + +A Rust library for cross-platform memory mapped IO. + +[![Build Status](https://travis-ci.org/danburkert/memmap-rs.svg?branch=master)](https://travis-ci.org/danburkert/memmap-rs) +[![Windows Build Status](https://ci.appveyor.com/api/projects/status/ubka00959pstatkg/branch/master?svg=true)](https://ci.appveyor.com/project/danburkert/mmap) +[![Documentation](https://docs.rs/memmap/badge.svg)](https://docs.rs/memmap) +[![Crate](https://img.shields.io/crates/v/memmap.svg)](https://crates.io/crates/memmap) + +## Features + +- [x] file-backed memory maps +- [x] anonymous memory maps +- [x] synchronous and asynchronous flushing +- [x] copy-on-write memory maps +- [x] read-only memory maps +- [x] stack support (`MAP_STACK` on unix) +- [x] executable memory maps +- [ ] huge page support + +## Platforms + +`memmap` should work on any platform supported by +[`libc`](https://github.com/rust-lang-nursery/libc#platforms-and-documentation). +`memmap` requires Rust stable 1.13 or greater. + +`memmap` is continuously tested on: + * `x86_64-unknown-linux-gnu` (Linux) + * `i686-unknown-linux-gnu` + * `x86_64-unknown-linux-musl` (Linux MUSL) + * `x86_64-apple-darwin` (OSX) + * `i686-apple-darwin` + * `x86_64-pc-windows-msvc` (Windows) + * `i686-pc-windows-msvc` + * `x86_64-pc-windows-gnu` + * `i686-pc-windows-gnu` + +`memmap` is continuously cross-compiled against: + * `arm-linux-androideabi` (Android) + * `aarch64-unknown-linux-gnu` (ARM) + * `arm-unknown-linux-gnueabihf` + * `mips-unknown-linux-gnu` (MIPS) + * `x86_64-apple-ios` (iOS) + * `i686-apple-ios` + +## License + +`memmap` is primarily distributed under the terms of both the MIT license and the +Apache License (Version 2.0). + +See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT) for details. + +Copyright (c) 2015 Dan Burkert. |