Ready 0.5 release

Cleanup documentation.
Remove some stale types.
Simplify some methods.
Fix no_std issues.
Fix clippy warnings.
Update github workflows.

Signed-off-by: Tin Švagelj <[email protected]>

.github/workflows/ci.yml

@@ -40,7 +40,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+          toolchain: nightly
           profile: minimal
           components: clippy
           override: true

.github/workflows/semver.yml

@@ -18,6 +18,6 @@ jobs:
         uses: baptiste0928/cargo-install@v2
         with:
           crate: cargo-semver-checks
-          version: "^0.23"
+          version: "^0.30"
       - name: Run semver check
         run: cargo semver-checks check-release

Cargo.toml

@@ -15,10 +15,17 @@ path = "examples/ptr_metadata.rs"
 required-features = ["ptr_metadata"]
 
 [features]
-default = ["unsafe_impl", "ptr_metadata", "debug"]
+default = [
+    "no_std",
+    "unsafe_impl",
+    "debug",
+    "ptr_metadata",
+    "error_in_core",
+    "allocator_api",
+]
 
 no_std = [] # No-std support
-debug = [] # Enable debug attributes
+debug = []  # Enable debug attributes
 
 # Implementations
 unsafe_impl = []

README.md

@@ -1,7 +1,7 @@
 # contiguous_mem
 
 contiguous_mem is a vector like collection that can store entries with
-heterogeneous layouts while retaining type safety at the reference level.
+heterogeneous layouts while retaining type information at the reference level.
 
 [![Crate](https://img.shields.io/crates/v/contiguous_mem?style=for-the-badge&logo=docs.rs)](https://crates.io/crates/contiguous_mem)
 [![Documentation](https://img.shields.io/docsrs/contiguous-mem?style=for-the-badge&logo=rust)](https://docs.rs/contiguous-mem)
@@ -32,7 +32,8 @@ over when your scope and requirements shift.
 ## Use cases
 
 - Storing differently typed/sized data. ([example](./examples/default_impl.rs))
-- Ensuring stored data is placed adjacently in memory. ([example](./examples/game_loading.rs))
+- Ensuring stored data is placed adjacently in memory.
+  ([example](./examples/game_loading.rs))
   - Note that returned references are **not** contiguous, only data they refer
     to is.
 
@@ -42,14 +43,14 @@ Add the crate to your dependencies:
 
 ```toml
 [dependencies]
-contiguous_mem = { version = "0.4" }
+contiguous_mem = { version = "0.5" }
 ```
 
 Optionally enable `no_std` feature to use in `no_std` environment:
 
 ```toml
 [dependencies]
-contiguous_mem = { version = "0.4", features = ["no_std"] }
+contiguous_mem = { version = "0.5", features = ["no_std"] }
 ```
 
 ### Features

doc/crate.md

@@ -1,5 +1,5 @@
 contiguous_mem is a vector like collection that can store entries with
-heterogeneous layouts while retaining type safety at the reference level.
+heterogeneous layouts while retaining type information at the reference level.
 
 ## Features
 

examples/default_impl.rs

@@ -17,4 +17,8 @@ fn main() {
     // Retrieve and use the stored data
     assert_eq!(*stored_data.get(), data);
     assert_eq!(*stored_number.get(), 22);
+
+    // All stored data gets cleaned up once `memory` goes out of scope, or we
+    // can forget it existed:
+    memory.forget();
 }

examples/game_loading.rs

@@ -32,6 +32,10 @@ impl<T> IndexOrPtr<T> {
 }
 
 pub trait Load {
+    /// # Safety
+    /// 
+    /// Loading is unsafe, that's why the game is so fun - you don't know
+    /// whether you'll be able to continue playing if you ever stop.
     unsafe fn load<R: Read>(data: R) -> Self;
 }
 pub trait Save {
@@ -177,22 +181,18 @@ fn main() {
     );
 
     // Create enemy lookup list.
-    let enemies: &[*const Enemy] = unsafe {
-        &[
-            data.push(load_game_file("enemy1.dat")),
-            data.push(load_game_file("enemy2.dat")),
-            data.push(load_game_file("enemy3.dat")),
-            data.push(load_game_file("enemy4.dat")),
-        ]
-    };
+    let enemies: &[*const Enemy] = &[
+        data.push(load_game_file("enemy1.dat")),
+        data.push(load_game_file("enemy2.dat")),
+        data.push(load_game_file("enemy3.dat")),
+        data.push(load_game_file("enemy4.dat")),
+    ];
 
     // Create level lookup list.
-    let levels: &[*mut Level] = unsafe {
-        &[
-            data.push(load_game_file("level1.dat")),
-            data.push(load_game_file("level2.dat")),
-        ]
-    };
+    let levels: &[*mut Level] = &[
+        data.push(load_game_file("level1.dat")),
+        data.push(load_game_file("level2.dat")),
+    ];
 
     // data won't go out of scope while we're using it in this example, but in
     // your use case it might. This is here for completeness.

examples/ptr_metadata.rs

@@ -1,6 +1,6 @@
 #![feature(ptr_metadata)]
 
-use contiguous_mem::{memory::DefaultMemoryManager, types::ImplDefault, *};
+use contiguous_mem::{types::ImplDefault, *};
 
 trait Greetable {
     fn print_hello(&self);