diff options
Diffstat (limited to 'third_party/rust/memmap2/README.md')
-rw-r--r-- | third_party/rust/memmap2/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/third_party/rust/memmap2/README.md b/third_party/rust/memmap2/README.md new file mode 100644 index 0000000000..df0252b1ad --- /dev/null +++ b/third_party/rust/memmap2/README.md @@ -0,0 +1,33 @@ +# memmap2 +![Build Status](https://github.com/RazrFalcon/memmap2-rs/workflows/Rust/badge.svg) +[![Crates.io](https://img.shields.io/crates/v/memmap2.svg)](https://crates.io/crates/memmap2) +[![Documentation](https://docs.rs/memmap2/badge.svg)](https://docs.rs/memmap2) +[![Rust 1.36+](https://img.shields.io/badge/rust-1.36+-orange.svg)](https://www.rust-lang.org) + +A Rust library for cross-platform memory mapped IO. + +This is a **fork** of the [memmap-rs](https://github.com/danburkert/memmap-rs) crate. + +## 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 + +A list of supported/tested targets can be found in [Actions](https://github.com/RazrFalcon/memmap2-rs/actions). + +## License + +`memmap2` 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) 2020 Yevhenii Reizner + +Copyright (c) 2015 Dan Burkert |