docs: fix some outdated links and descriptions #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you |
vmx
added a commit
that referenced
this pull request
Sep 30, 2020
Instead of deriving a Multihash enum, derive from a Code enum. This commit also combines the previously generated `Multihash` enum with the `RawMultihash` struct. There is now a single `Multihash` type which is generic over its digest size. The derived `Code` enum is used for hashing, the `Multihash` only contains static, general data. Closes #12, #13.
vmx
pushed a commit
that referenced
this pull request
Sep 30, 2020
* feat: derive from Code enum Instead of deriving a Multihash enum, derive from a Code enum. This commit also combines the previously generated `Multihash` enum with the `RawMultihash` struct. There is now a single `Multihash` type which is generic over its digest size. The derived `Code` enum is used for hashing, the `Multihash` only contains static, general data. Closes #12, #13. * fix: don't clone the digest * feat: introduce `max_size` attribute The digests are stack allocated. We cannot determine the biggest digest size that is used at compile time, hence you need to specify the maximum allocated size your custom code table should use via `[#mh(max_size = …)]` on the enum you derive the table from. * fix: enable the arb module again * fix: properly use local versions of imports This way you only need to import the derive and not also additional (seemingly unrelated) types. * fix: make Serde support work again * fix: make Parity Scale Codec support work again * feat: create MultihashCode trait Instead of just implementing it on the code enum, use a trait instead. This way other libraries can create digests without knowing the concrete type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the doc link to https://docs.rs/multihash, which will auto-update when new a new version is published to crates.io. Currently, the docs hosted on Github pages are out of date.
I also added a doc link to
Cargo.tomlso a documentation link shows up on crates.io.Finally, I updated the README section and the doc comments about supported hash functions so they represent the current state of the code.