Release 0.1.0

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 David Koloski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+# ptr_meta   [![Latest Version]][crates.io] [![License]][license path] [![requires: rustc 1.47+]][Rust 1.47]
+
+[Latest Version]: https://img.shields.io/crates/v/ptr_meta.svg
+[crates.io]: https://crates.io/crates/ptr_meta
+[License]: https://img.shields.io/badge/license-MIT-blue.svg
+[license path]: https://github.com/djkoloski/ptr_meta/blob/master/LICENSE
+[requires: rustc 1.47+]: https://img.shields.io/badge/rustc-1.47+-lightgray.svg
+[Rust 1.47]: https://blog.rust-lang.org/2020/10/08/Rust-1.47.html
+
+# ptr_meta
+
+A radioactive stabilization of the [`ptr_meta` RFC][rfc].
+
+[rfc]: https://rust-lang.github.io/rfcs/2580-ptr-meta.html
+
+## Usage
+
+### Sized types
+
+Sized types already have `Pointee` implemented for them, so most of the time you won't have to worry
+about them. However, trying to derive `Pointee` for a struct that may or may not have a DST as its
+last field will cause an implementation conflict with the automatic sized implementation.
+
+### `slice`s and `str`s
+
+These core types have implementations built in.
+
+### Structs with a DST as its last field
+
+You can derive `Pointee` for last-field DSTs:
+
+```rust
+use ptr_meta::Pointee;
+
+#[derive(Pointee)]
+struct Block<H, T> {
+    header: H,
+    elements: [T],
+}
+```
+
+### Trait objects
+
+You can generate a `Pointee` for trait objects:
+
+```rust
+use ptr_meta::pointee;
+
+// Generates Pointee for dyn Stringy
+#[pointee]
+trait Stringy {
+    fn as_string(&self) -> String;
+}
+```

ptr_meta/Cargo.toml

@@ -3,6 +3,13 @@ name = "ptr_meta"
 version = "0.1.0"
 authors = ["David Koloski <[email protected]>"]
 edition = "2018"
+description = "A radioactive stabilization of the ptr_meta rfc"
+license = "MIT"
+documentation = "https://docs.rs/ptr_meta"
+repository = "https://github.com/djkoloski/ptr_meta"
+keywords = ["ptr", "meta", "no_std"]
+categories = ["no-std"]
+readme = "crates-io.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

ptr_meta/README.md

@@ -0,0 +1,54 @@
+# ptr_meta   [![Latest Version]][crates.io] [![License]][license path] [![requires: rustc 1.47+]][Rust 1.47]
+
+[Latest Version]: https://img.shields.io/crates/v/ptr_meta.svg
+[crates.io]: https://crates.io/crates/ptr_meta
+[License]: https://img.shields.io/badge/license-MIT-blue.svg
+[license path]: https://github.com/djkoloski/ptr_meta/blob/master/LICENSE
+[requires: rustc 1.47+]: https://img.shields.io/badge/rustc-1.47+-lightgray.svg
+[Rust 1.47]: https://blog.rust-lang.org/2020/10/08/Rust-1.47.html
+
+# ptr_meta
+
+A radioactive stabilization of the [`ptr_meta` RFC][rfc].
+
+[rfc]: https://rust-lang.github.io/rfcs/2580-ptr-meta.html
+
+## Usage
+
+### Sized types
+
+Sized types already have `Pointee` implemented for them, so most of the time you won't have to worry
+about them. However, trying to derive `Pointee` for a struct that may or may not have a DST as its
+last field will cause an implementation conflict with the automatic sized implementation.
+
+### `slice`s and `str`s
+
+These core types have implementations built in.
+
+### Structs with a DST as its last field
+
+You can derive `Pointee` for last-field DSTs:
+
+```rust
+use ptr_meta::Pointee;
+
+#[derive(Pointee)]
+struct Block<H, T> {
+    header: H,
+    elements: [T],
+}
+```
+
+### Trait objects
+
+You can generate a `Pointee` for trait objects:
+
+```rust
+use ptr_meta::pointee;
+
+// Generates Pointee for dyn Stringy
+#[pointee]
+trait Stringy {
+    fn as_string(&self) -> String;
+}
+```

ptr_meta/crates-io.md

@@ -0,0 +1,45 @@
+# ptr_meta
+
+A radioactive stabilization of the [`ptr_meta` RFC][rfc].
+
+[rfc]: https://rust-lang.github.io/rfcs/2580-ptr-meta.html
+
+## Usage
+
+### Sized types
+
+Sized types already have `Pointee` implemented for them, so most of the time you won't have to worry
+about them. However, trying to derive `Pointee` for a struct that may or may not have a DST as its
+last field will cause an implementation conflict with the automatic sized implementation.
+
+### `slice`s and `str`s
+
+These core types have implementations built in.
+
+### Structs with a DST as its last field
+
+You can derive `Pointee` for last-field DSTs:
+
+```rust
+use ptr_meta::Pointee;
+
+#[derive(Pointee)]
+struct Block<H, T> {
+    header: H,
+    elements: [T],
+}
+```
+
+### Trait objects
+
+You can generate a `Pointee` for trait objects:
+
+```rust
+use ptr_meta::pointee;
+
+// Generates Pointee for dyn Stringy
+#[pointee]
+trait Stringy {
+    fn as_string(&self) -> String;
+}
+```

ptr_meta/src/lib.rs

@@ -1,6 +1,48 @@
 //! A radioactive stabilization of the [`ptr_meta` RFC][rfc].
 //!
 //! [rfc]: https://rust-lang.github.io/rfcs/2580-ptr-meta.html
+//!
+//! ## Usage
+//!
+//! ### Sized types
+//!
+//! Sized types already have `Pointee` implemented for them, so most of the time you won't have to worry
+//! about them. However, trying to derive `Pointee` for a struct that may or may not have a DST as its
+//! last field will cause an implementation conflict with the automatic sized implementation.
+//!
+//! ### `slice`s and `str`s
+//!
+//! These core types have implementations built in.
+//!
+//! ### Structs with a DST as its last field
+//!
+//! You can derive `Pointee` for last-field DSTs:
+//!
+//! ```
+//! use ptr_meta::Pointee;
+//!
+//! #[derive(Pointee)]
+//! struct Block<H, T> {
+//!     header: H,
+//!     elements: [T],
+//! }
+//! ```
+//!
+//! ### Trait objects
+//!
+//! You can generate a `Pointee` for trait objects:
+//!
+//! ```
+//! use ptr_meta::pointee;
+//!
+//! // Generates Pointee for dyn Stringy
+//! #[pointee]
+//! trait Stringy {
+//!     fn as_string(&self) -> String;
+//! }
+//! ```
+
+#![no_std]
 
 mod impls;
 
@@ -13,7 +55,7 @@ use core::{
     ptr,
 };
 
-pub use ptr_meta_derive::{ptr_meta, Pointee};
+pub use ptr_meta_derive::{pointee, Pointee};
 
 /// Provides the pointer metadata type of any pointed-to type.
 ///
@@ -279,7 +321,7 @@ impl<Dyn: ?Sized> hash::Hash for DynMetadata<Dyn> {
 #[cfg(test)]
 mod tests {
     use crate as ptr_meta;
-    use super::{from_raw_parts, ptr_meta, Pointee, PtrExt};
+    use super::{from_raw_parts, pointee, Pointee, PtrExt};
 
     fn test_pointee<T: Pointee + ?Sized>(value: &T) {
         let ptr = value as *const T;
@@ -325,7 +367,7 @@ mod tests {
 
     #[test]
     fn trait_objects() {
-        #[ptr_meta]
+        #[pointee]
         trait TestTrait {
             fn foo(&self);
         }
@@ -376,5 +418,14 @@ mod tests {
         struct TestDyn {
             tail: dyn core::any::Any,
         }
+
+        #[pointee]
+        trait TestTrait {}
+
+        #[allow(dead_code)]
+        #[derive(Pointee)]
+        struct TestCustomDyn {
+            tail: dyn TestTrait,
+        }
     }
 }

ptr_meta_derive/src/lib.rs

@@ -54,7 +54,7 @@ fn derive_pointee_impl(input: &DeriveInput) -> TokenStream {
 
 /// Generates an implementation of `Pointee` for trait objects.
 #[proc_macro_attribute]
-pub fn ptr_meta(
+pub fn pointee(
     _attr: proc_macro::TokenStream,
     item: proc_macro::TokenStream,
 ) -> proc_macro::TokenStream {