7 releases

0.2.2 Aug 22, 2018
0.2.1 Apr 11, 2018
0.2.0 Mar 15, 2018
0.1.3 Feb 4, 2018
0.1.0 Dec 29, 2017

#2 in Cryptocurrencies

Download history 1663/week @ 2018-09-18 1820/week @ 2018-09-25 1892/week @ 2018-10-02 1449/week @ 2018-10-09 1960/week @ 2018-10-16 1899/week @ 2018-10-23 2412/week @ 2018-10-30 2928/week @ 2018-11-06 3737/week @ 2018-11-13 3875/week @ 2018-11-20 2960/week @ 2018-11-27 3879/week @ 2018-12-04 4128/week @ 2018-12-11

7,026 downloads per month
Used in 30 crates (5 directly)

MIT license

38KB
946 lines

Fixed Hash

Provides macros to construct custom fixed-size hash types.

Examples

Simple 256 bit (32 bytes) hash type.

#[macro_use] extern crate fixed_hash;

construct_fixed_hash! {
    /// My 256 bit hash type.
    pub struct H256(32);
}

Opt-in to add conversions between differently sized hashes.

construct_fixed_hash!{ struct H256(32); }
construct_fixed_hash!{ struct H160(20); }
// auto-implement conversions between H256 and H160
impl_fixed_hash_conversions!(H256, H160);
// now use the generated conversions
assert_eq!(H256::from(H160::zero()), H256::zero());
assert_eq!(H160::from(H256::zero()), H160::zero());

It is possible to add attributes to your types, for example to make them serializable.

extern crate serde;
#[macro_use] extern crate serde_derive;

construct_fixed_hash!{
    /// My serializable hash type.
    #[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
    struct H160(20);
}

Features

By default this is an standard library depending crate.
For a #[no_std] environment use it as follows:

fixed-hash = { version = "0.3", default-features = false }

Available Features

  • std: Use the standard library instead of the core library.
    • Using this feature enables the following features
      • rustc-hex/std
      • rand/std
      • byteorder/std
    • Enabled by default.
  • libc: Use libc for implementations of PartialEq and Ord.
    • Enabled by default.
  • rand: Provide API based on the rand crate.
    • Enabled by default.
  • byteorder: Provide API based on the byteorder crate.
    • Enabled by default.
  • heapsize: Provide HeapsizeOf implementation for hash types.
    • Disabled by default.
  • quickcheck: Provide quickcheck implementation for hash types.
    • Disabled by default.
  • api-dummy: Generate a dummy hash type for API documentation.
    • Enabled by default at docs.rs

Dependencies

~1MB
~12K SLoC