History

Trangar 86e03aeda7 Rewrite: seperated Decode and BorrowDecode (#526 ) * Rewrite: seperated Decode and BorrowDecode * Fixed cargo.toml issues * Fixed clippy warning * Removed the `impl_tuples` macro call with manually exported code * Replaced the generated code in `impl_tuples` with the macro instead * Implemented BorrowDecode for Box<[T]> * Added a test to see if zoxide can be ported to bincode 2 * Added a test for Arc<str> * Made several `Encode` implementations require `T: ?Sized` * Implemented Decode for Arc<str> * Added BlockedTODO links to commented out code * Fixed clippy and lint issues * Updated virtue dependency in fuzz lockfile		2022-06-04 15:23:55 +02:00
..
src	Rewrite: seperated Decode and BorrowDecode (#526 )	2022-06-04 15:23:55 +02:00
.gitignore	Removed derive/Cargo.lock	2021-09-13 13:22:47 +02:00
Cargo.toml	Rewrite: seperated Decode and BorrowDecode (#526 )	2022-06-04 15:23:55 +02:00
readme.md	Refactor and rename encoders	2021-10-17 16:22:14 +02:00

readme.md

Bincode-derive

The derive crate for bincode. Implements bincode::Encode and bincode::Decode.

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>_Encode.rs and <struct/enum name>_Decode.rs. This can help with debugging.