Apply more suggestions from code review, update documentation

Author: mobiusklein

soa-derive-internal/src/iter.rs

@@ -1,6 +1,5 @@
 use proc_macro2::TokenStream;
 use quote::quote;
-use quote::TokenStreamExt;
 
 use crate::input::{Input, TokenStreamIterator};
 use crate::names;
@@ -80,7 +79,7 @@ pub fn derive(input: &Input) -> TokenStream {
         }
     }).expect("should be Some");
 
-    let mut generated = quote! {
+    let generated = quote! {
         /// Iterator over
         #[doc = #doc_url]
         #[allow(missing_debug_implementations)]
@@ -134,14 +133,14 @@ pub fn derive(input: &Input) -> TokenStream {
             /// Get an iterator over the
             #[doc = #ref_doc_url]
             /// in this slice.
-            pub fn iter(&self) -> <#name as ::soa_derive::SoAIter>::Iter {
+            pub fn iter(&self) -> #iter_name {
                 #iter_name(#create_iter)
             }
 
             /// Get an iterator over the
             #[doc = #ref_doc_url]
             /// in this slice.
-            pub fn into_iter(self) -> <#name as ::soa_derive::SoAIter<'a>>::Iter {
+            pub fn into_iter(self) -> #iter_name<'a> {
                 #iter_name(#create_into_iter)
             }
         }
@@ -189,7 +188,7 @@ pub fn derive(input: &Input) -> TokenStream {
             /// Get a mutable iterator over the
             #[doc = #ref_mut_doc_url]
             /// in this vector
-            pub fn iter_mut(&mut self) -> <#name as ::soa_derive::SoAIter>::IterMut {
+            pub fn iter_mut(&mut self) -> #iter_mut_name {
                 self.as_mut_slice().into_iter()
             }
         }
@@ -198,21 +197,21 @@ pub fn derive(input: &Input) -> TokenStream {
             /// Get an iterator over the
             #[doc = #ref_doc_url]
             /// in this vector
-            pub fn iter(&mut self) -> <#name as ::soa_derive::SoAIter>::Iter {
+            pub fn iter(&mut self) -> #iter_name {
                 self.as_ref().into_iter()
             }
 
             /// Get a mutable iterator over the
             #[doc = #ref_mut_doc_url]
             /// in this vector
-            pub fn iter_mut(&mut self) -> <#name as ::soa_derive::SoAIter>::IterMut {
+            pub fn iter_mut(&mut self) -> #iter_mut_name {
                 #iter_mut_name(#create_iter_mut)
             }
 
             /// Get a mutable iterator over the
             #[doc = #ref_mut_doc_url]
             /// in this vector
-            pub fn into_iter(self) -> <#name as ::soa_derive::SoAIter<'a>>::IterMut {
+            pub fn into_iter(self) -> #iter_mut_name<'a> {
                 #iter_mut_name(#create_mut_into_iter)
             }
         }
@@ -297,15 +296,9 @@ pub fn derive(input: &Input) -> TokenStream {
                 self.extend(iter.into_iter().map(|item| item.to_owned()))
             }
         }
-    };
-
-    {
-        generated.append_all(quote! {
 
-            impl<'a> ::soa_derive::IntoSoAIter<'a, #name> for #slice_name<'a> {}
-
-        })
-    }
+        impl<'a> ::soa_derive::IntoSoAIter<'a, #name> for #slice_name<'a> {}
+    };
 
     return generated;
 }

soa-derive-internal/src/slice.rs

@@ -55,8 +55,6 @@ pub fn derive(input: &Input) -> TokenStream {
         |ident, _| quote! { ::std::slice::from_raw_parts(data.#ident, len) },
     ).collect::<Vec<_>>();
 
-    let iter_name = names::iter_name(name);
-
     let mut generated = quote! {
         /// A slice of
         #[doc = #doc_url]
@@ -347,9 +345,6 @@ pub fn derive_mut(input: &Input) -> TokenStream {
         |ident, _| quote! { permutation.apply_slice_in_place(&mut self.#ident) },
     ).collect::<Vec<_>>();
 
-    let iter_name = names::iter_name(name);
-    let iter_mut_name = names::iter_mut_name(name);
-
     let mut generated = quote! {
         /// A mutable slice of
         #[doc = #doc_url]

soa-derive-internal/src/vec.rs

@@ -67,9 +67,6 @@ pub fn derive(input: &Input) -> TokenStream {
         |ident, _| quote! { ::std::mem::replace(&mut self.#ident[index], field) },
     ).collect::<Vec<_>>();
 
-    let iter_name = names::iter_name(name);
-    let iter_mut_name = names::iter_mut_name(name);
-
     let mut generated = quote! {
         /// An analog to `
         #[doc = #vec_name_str]
@@ -471,19 +468,15 @@ pub fn derive(input: &Input) -> TokenStream {
                     )*
                 }
             }
-        });
 
-        {
-            generated.append_all(quote! {
-                impl ::soa_derive::SoAAppendVec<#name> for #vec_name {
-                    fn extend_from_slice(&mut self, other: Self::Slice<'_>) {
-                        #(
-                            self.#fields_names.extend_from_slice(other.#fields_names);
-                        )*
-                    }
+            impl ::soa_derive::SoAAppendVec<#name> for #vec_name {
+                fn extend_from_slice(&mut self, other: Self::Slice<'_>) {
+                    #(
+                        self.#fields_names.extend_from_slice(other.#fields_names);
+                    )*
                 }
-            })
-        }
+            }
+        });
     }
 
     return generated;

src/lib.rs

@@ -232,19 +232,13 @@
 //! `StructOfArray` does not provide a set of common operations by default. Thus if you wanted to use a `StructOfArray`
 //! type in a generic context, there is no way to guarantee to the type system that any methods are available.
 //!
-//! If the `generic_traits` feature is enabled, the attribute macro `#[generate_traits]` will generate
-//! implementations of [`SoAVec`], [`SoASlice`], and [`SoASliceMut`] for the respective `Vec`, `Slice`
-//! and `SliceMut` types.
-//!
-//! These rely on GATs, and so require Rust 1.65 or newer, and so this feature is disabled by default.
-//! Even when enabled, trait implementations are only generated by opting in with the `#[generate_traits]`
-//! attribute.
+//! This will also generate implementations of [`SoAVec`], [`SoASlice`], and [`SoASliceMut`] for the respective
+//! `Vec`, `Slice` and `SliceMut` types. These rely on GATs, and so require Rust 1.65 or newer.
 //!
 //! ```ignore
 //! # mod cheese {
 //! # use soa_derive::{StructOfArray, prelude::*};
 //! #[derive(StructOfArray)]
-//! #[generate_traits]
 //! pub struct Point {
 //!     x: f32,
 //!     y: f32,
@@ -415,8 +409,15 @@ macro_rules! soa_zip {
     }};
 }
 
+
+/// This trait is automatically implemented by the relevant generated by [`StructOfArray`].
+///
+/// Links a [`StructOfArray`] type to its raw pointer types, which is useful for generic
+/// programming.
 pub trait SoAPointers {
+    /// The immutable pointer type for an SoA type
     type Ptr;
+    /// The mutable pointer type for an SoA type
     type MutPtr;
 }