multihash-derive-impl is a procedural macro. It will run at compile time and transform your program's source code.

Adding `multihash-derive-impl` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add multihash-derive-impl

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

multihash-derive-impl = "0.1.2"

You may need to import the macro(s) with use multihash_derive_impl::*.

Read the multihash_derive_impl documentation.

Back to the crate overview.

Readme

rust-multihash

multihash implementation in Rust.

Install
Usage
Supported Hash Types
Maintainers
Contribute
License

Install

First add this to your Cargo.toml

[dependencies]
multihash = "*"

Then run cargo build.

MSRV

The minimum supported Rust version for this library is 1.64.0. This is only guaranteed without additional features activated.

Usage

The multihash crate exposes a basic data structure for encoding and decoding multihash. It does not provide any hashing functionality itself. Multihash uses const-generics to define the internal buffer size. You should set this to the maximum size of the digest you want to support.

use multihash::Multihash;

const SHA2_256: u64 = 0x12;

fn main() {
	let hash = Multihash::<64>::wrap(SHA2_256, b"my digest");
	println!("{:?}", hash);
}

Using a custom code table

You can derive your own application specific code table using the multihash-derive crate. The multihash-codetable provides predefined hasher implementations if you don't want to implement your own.

use multihash_derive::MultihashDigest;

#[derive(Clone, Copy, Debug, Eq, MultihashDigest, PartialEq)]
#[mh(alloc_size = 64)]
pub enum Code {
    #[mh(code = 0x01, hasher = multihash_codetable::Sha2_256)]
    Foo,
    #[mh(code = 0x02, hasher = multihash_codetable::Sha2_512)]
    Bar,
}

fn main() {
    let hash = Code::Foo.digest(b"my hash");
    println!("{:02x?}", hash);
}

Supported Hash Types

SHA1
SHA2-256
SHA2-512
SHA3/Keccak
Blake2b-256/Blake2b-512/Blake2s-128/Blake2s-256
Blake3
Strobe

Maintainers

Captain: @dignifiedquire.

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT

Adding multihash-derive-impl macro(s) as a dependency

Adding `multihash-derive-impl` macro(s) as a dependency