diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 0 insertions, 36 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index c008bc9..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -[![Build Status](https://github.com/avitex/rust-aliasable/workflows/build/badge.svg)](https://github.com/avitex/rust-aliasable/actions?query=workflow:build) -[![Coverage Status](https://codecov.io/gh/avitex/rust-aliasable/branch/master/graph/badge.svg?token=X2LXHI8VYL)](https://codecov.io/gh/avitex/rust-aliasable) -[![Crate](https://img.shields.io/crates/v/aliasable.svg)](https://crates.io/crates/aliasable) -[![Docs](https://docs.rs/aliasable/badge.svg)](https://docs.rs/aliasable) - -# rust-aliasable - -**Rust library providing basic aliasable (non `core::ptr::Unique`) types** -Documentation hosted on [docs.rs](https://docs.rs/aliasable). - -```toml -aliasable = "0.1" -``` - -## Why? - -Used for escaping `noalias` when multiple raw pointers may point to the same -data. - -## Goals - -`aliasable` is not designed to provide a full interface for container types, -simply to provide aliasable (non `core::ptr::Unique`) alternatives for -dereferencing their owned data. When converting from a unique to an aliasable -alternative, no data referenced is mutated (one-to-one internal representation -aside from the non `core::ptr::Unique` pointer). - -## Usage - -```rust -use aliasable::vec::AliasableVec; - -// Re-exported via `aliasable::vec::UniqueVec` -let unique = Vec::from(&[1, 2, 3][..]); -let aliasable = AliasableVec::from(unique); -``` |