1# memmap2
2![Build Status](https://github.com/RazrFalcon/memmap2-rs/workflows/Rust/badge.svg)
3[![Crates.io](https://img.shields.io/crates/v/memmap2.svg)](https://crates.io/crates/memmap2)
4[![Documentation](https://docs.rs/memmap2/badge.svg)](https://docs.rs/memmap2)
5[![Rust 1.36+](https://img.shields.io/badge/rust-1.36+-orange.svg)](https://www.rust-lang.org)
6
7A Rust library for cross-platform memory mapped IO.
8
9This is a **fork** of the [memmap-rs](https://github.com/danburkert/memmap-rs) crate.
10
11## Features
12
13- [x] file-backed memory maps
14- [x] anonymous memory maps
15- [x] synchronous and asynchronous flushing
16- [x] copy-on-write memory maps
17- [x] read-only memory maps
18- [x] stack support (`MAP_STACK` on unix)
19- [x] executable memory maps
20- [ ] huge page support
21
22A list of supported/tested targets can be found in [Actions](https://github.com/RazrFalcon/memmap2-rs/actions).
23
24## License
25
26`memmap2` is primarily distributed under the terms of both the MIT license and the
27Apache License (Version 2.0).
28
29See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT) for details.
30
31Copyright (c) 2020 Yevhenii Reizner
32
33Copyright (c) 2015 Dan Burkert
34