prepare enum-field-getter for publishing to crates.io (#21)

Author: pufferfish101007

Cargo.toml

@@ -2,6 +2,7 @@
 name = "hyperquark"
 version = "0.0.0"
 edition = "2021"
+publish = false
 
 [dependencies]
 serde = { version = "1.0", default-features = false, features = ["derive", "alloc"] }

enum-field-getter/.gitignore

@@ -0,0 +1,2 @@
+/target
+/Cargo.lock

enum-field-getter/Cargo.toml

@@ -2,6 +2,10 @@
 name = "enum-field-getter"
 version = "0.1.0"
 edition = "2021"
+license = "MIT OR Apache-2.0"
+repository = "hhttps://github.com/HyperQuark/hyperquark/tree/main/enum-field-getter"
+authors = ["pufferfish101007"]
+description = "A derive macro to create mutable and immutable getters for tuple/struct members of enum variants"
 
 [lib]
 proc-macro = true

enum-field-getter/README.md

@@ -0,0 +1,50 @@
+# `enum-field-getter`
+
+A simple derive macro used to implement methods to access fields which are of the same type across every tuple/struct enum variant.
+
+## Usage
+
+Derive `EnumFieldGetter`. For tuple enum variants, produces `get_n(&self) -> Option<&_>` and `get_n_mut(&mut self) -> Option<&mut _>` methods for each tuple member (starting from 0); for struct variants, getters are of the form `prop(&self) -> Option<&_>` and `prop_mut(&mut self) -> Option<&mut _>`. Getters are only produced so long as that member is the same type across all enum variants - if they are of different types, no getter will be produced for that member. These methods are produced even if that member doesn't exist for all enum variants - in the case that it doesn't exist, the getter will return `None`.
+
+## Examples
+
+```rust
+use enum_field_getter::EnumFieldGetter;
+
+#[derive(EnumFieldGetter)]
+enum Foo {
+    Bar(u32),
+    Baz(u32, u32),
+}
+
+let foo = Foo::Bar(16);
+let foo0 = foo.get_0();
+assert_eq!(foo0, Some(&16));
+let foo1 = foo.get_1();
+assert!(foo1.is_none());
+```
+
+```rust
+use enum_field_getter::EnumFieldGetter;
+
+#[derive(EnumFieldGetter)]
+enum Boop {
+    Moo {
+        a: i32,
+        b: i32,
+    },
+    Baa {
+        a: i32,
+        b: i32,
+        c: i32,
+    }
+}
+
+let mut boop = Boop::Baa { a: 0, b: 42, c: 180 };
+let boop_a = boop.a();
+assert_eq!(boop_a, Some(&0));
+let boop_c = boop.c();
+assert_eq!(boop_c, Some(&180));
+*boop.b_mut().unwrap() = 43;
+assert_eq!(boop.b(), Some(&43));
+```

enum-field-getter/src/lib.rs

@@ -1,10 +1,13 @@
+#![doc = include_str!("../README.md")]
+
 use proc_macro::TokenStream;
 use proc_macro_error::{abort_call_site, emit_warning, proc_macro_error};
 use quote::{format_ident, quote};
 use syn::{parse_macro_input, Data, DeriveInput, Fields, Type};
 
 use std::collections::{HashMap, HashSet};
 
+/// See top-level crate documentation.
 #[proc_macro_error]
 #[proc_macro_derive(EnumFieldGetter)]
 pub fn enum_field_getter(stream: TokenStream) -> TokenStream {