Make bincode_derive 0 dependencies

.github/workflows/rust.yml

@@ -162,7 +162,7 @@
           "uses": "actions-rs/[email protected]",
           "with": {
             "version": "0.18.2",
-            "args": "--exclude-files derive/"
+            "args": "--all"
           }
         },
         {

.gitignore

@@ -5,3 +5,4 @@
 .cargo
 .vscode
 rls*.log
+tarpaulin-report.html

Cargo.toml

@@ -6,7 +6,7 @@ members = [
 [package]
 name = "bincode"
 version = "2.0.0-dev" # remember to update html_root_url and bincode_derive
-authors = ["Ty Overby <[email protected]>", "Francesco Mazzoli <[email protected]>", "Zoey Riordan <[email protected]>"]
+authors = ["Ty Overby <[email protected]>", "Francesco Mazzoli <[email protected]>", "Zoey Riordan <[email protected]>", "Victor Koenders <[email protected]>"]
 exclude = ["logo.png", "examples/*", ".gitignore", ".github/"]
 
 publish =  true
@@ -30,4 +30,9 @@ derive = ["bincode_derive"]
 
 [dependencies]
 bincode_derive = { path = "derive", version = "2.0.0-dev", optional = true }
-# serde = { version = "1.0.130", optional = true }
+serde = { version = "1.0.130", optional = true }
+
+# Used for derive tests
+[dev-dependencies]
+serde_derive = "1.0.130"
+serde_json = "1.0.68"

derive/Cargo.toml

@@ -1,16 +1,17 @@
-[package]
-name = "bincode_derive"
-version = "2.0.0-dev" # remember to update bincode
-edition = "2018"
-
-[lib]
-proc-macro = true
-
-[dependencies]
-quote = "1.0.9"
-proc-macro2 = "1.0"
-
-[dependencies.syn]
-version = "1.0.74"
-default-features = false
-features  = ["parsing", "derive", "proc-macro", "printing", "clone-impls"]
+[package]
+name = "bincode_derive"
+version = "2.0.0-dev" # remember to update bincode
+authors = ["Zoey Riordan <[email protected]>", "Victor Koenders <[email protected]>"]
+edition = "2018"
+
+repository = "https://github.com/bincode-org/bincode"
+documentation = "https://docs.rs/bincode_derive"
+readme = "./readme.md"
+categories = ["encoding", "network-programming"]
+keywords = ["binary", "encode", "decode", "serialize", "deserialize"]
+
+[lib]
+proc-macro = true
+
+[dev-dependencies]
+proc-macro2 = "1.0"

derive/readme.md

@@ -0,0 +1,28 @@
+# Bincode-derive
+
+The derive crate for bincode. Implements `bincode::Encodable` and `bincode::Decodable`.
+
+This crate is roughly split into 2 parts:
+
+# Parsing
+
+Most of parsing is done in the `src/parse/` folder. This will generate the following types:
+- `Attributes`, not being used currently
+- `Visibility`, not being used currently
+- `DataType` either `Struct` or `Enum`, with the name of the data type being parsed
+- `Generics` the generics part of the type, e.g. `struct Foo<'a>`
+- `GenericConstraints` the "where" part of the type
+
+# Generate
+
+Generating the code implementation is done in either `src/derive_enum.rs` and `src/derive_struct.rs`.
+
+This is supported by the structs in `src/generate`. The most notable points of this module are:
+- `StreamBuilder` is a thin but friendly wrapper around `TokenStream`
+- `Generator` is the base type of the code generator. This has helper methods to generate implementations:
+  - `ImplFor` is a helper struct for a single `impl A for B` construction. In this functions can be defined:
+    - `GenerateFnBody` is a helper struct for a single function in the above `impl`. This is created with a callback to `FnBuilder` which helps set some properties. `GenerateFnBody` has a `stream()` function which returns ` StreamBuilder` for the function.
+
+For additional derive testing, see the test cases in `../tests`
+
+For testing purposes, all generated code is outputted to the current `target` folder, under file name `<struct/enum name>_Encodeable.rs` and `<struct/enum name>_Decodeable.rs`. This can help with debugging.