Split crate into multihash, multihash-codetable and multihash-derive

[thomaseizinger]

As discussed in #259.

This issue tracks the splitting up into smaller crates for the purpose of a more stable API.

[thomaseizinger]

I am tempted to introduce an additional crate: multihash-derive-impl. The reason is as follows.

There are several symbols that would reside in multihash that are only needed for the custom derive:

• MultihashDigest
• Hasher
• Error::UnsupportedCode

We could move all of those to multihash-derive, move the actual derive code to multihash-derive-impl and thus refer to these types via multihash-derive. multihash-derive would then also depend on multihash (and re-export) the struct.

This would reduce in an even smaller API surface of multihash. Thoughts @vmx?

[vmx]

Would it be an issue to have multihash-derive-impl and miltihash-derive in a single crate? I'd expect that most people would use them together anyway. Though I might be missing something.

[thomaseizinger]

Would it be an issue to have multihash-derive-impl and miltihash-derive in a single crate? I'd expect that most people would use them together anyway. Though I might be missing something.

The problem is that a proc-macro cannot declare regular Rust symbols like traits or structs because proc-macros are compiled for the host machine and the actual crates for the specified target.

Thus, the types like MultihashDigest, Hasher and UnsupportedCode cannot live next to the proc macro. To make things easier to use though, the macro from the -impl crate is typically re-exported, meaning users still just depend on multihash-derive.

I've implemented this here already: #272

As you can see, someone defining their own codetable would only depend on multihash-derive and get everything they need. Someone that just needs the data structure Multihash would depend on multihash.

[vmx]

Thanks for the explanation, that makes sense. Having this documented should make it easy enough to follow as the multihash-derive-impl will really be more or less an implementation detail of multihash-derive.

[thomaseizinger]

Done as part of #267.