<!-- this file uses https://github.com/livioribeiro/cargo-readme -->
<!-- do not manually edit README.md, instead edit README.tpl or src/lib.rs -->

# pagemap-rs

[![Crates.io](https://img.shields.io/crates/v/pagemap.svg)](https://crates.io/crates/pagemap)
[![docs.rs](https://docs.rs/pagemap/badge.svg)](https://docs.rs/pagemap)
[![GitHub License](https://img.shields.io/github/license/ckatsak/pagemap-rs?style=flat)](LICENSE)
[![deps.rs](https://deps.rs/repo/github/ckatsak/pagemap-rs/status.svg)](https://deps.rs/repo/github/ckatsak/pagemap-rs)
[![Build Status](https://travis-ci.com/ckatsak/pagemap-rs.svg?branch=main)](https://travis-ci.com/ckatsak/pagemap-rs)
[![GitHub Workflow Status](https://github.com/ckatsak/pagemap-rs/actions/workflows/basic.yml/badge.svg?branch=main)](https://github.com/ckatsak/pagemap-rs/actions/workflows/basic.yml)
<!--[![Travis (.com) branch](https://img.shields.io/travis/com/ckatsak/pagemap-rs/main)](https://travis-ci.com/ckatsak/pagemap-rs)-->
<!--[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ckatsak/pagemap-rs/basic.yml)](https://github.com/ckatsak/pagemap-rs/actions/workflows/basic.yml)-->

A crate to provide a simple API to Linux kernel's
[pagemap API](https://www.kernel.org/doc/Documentation/vm/pagemap.txt).

Check the [examples directory](./examples/) for a few examples of its usage.

## TODO

- [ ] Improve test coverage

## License

Distributed under the terms of the Apache License, Version 2.0.

For further details consult the included [LICENSE file](LICENSE) or http://www.apache.org/licenses/LICENSE-2.0.