package ppx_hash

  1. Overview
  2. Docs
A ppx rewriter that generates hash functions from type expressions and definitions

Install

Dune Dependency

Authors

Maintainers

Sources

ppx_hash-v0.11.0.tar.gz
md5=b448bfe48f78447070a3ab07d9285629

Description

Part of the Jane Street's PPX rewriters collection.

Published: 22 Mar 2018

README

ppx_hash

A ppx writer that generates hash functions from type expressions and definitions.

Syntax

Type definitions: [@@deriving hash] Expressions: [%hash_fold: TYPE] and [%hash: TYPE] Record fields: [@hash.ignore]

Basic usage

    type t = {
      s : string;
      x : (int * bool) list;
    }
    [@@deriving hash]

This will generate a function hash_fold_t : Hash.state -> t -> Hash.state.

Where Hash is Ppx_hash_lib.Std.Hash.

The generated function follows the structure of the type; allowing user overrides at every level. This is in contrast to ocaml's builtin polymorphic hashing Hashtbl.hash which ignores user overrides.

Also generated is a direct hash-function hash : t -> Hash.hash_value. This function will be named hash_<T> when != "t".

The direct hash function is the one suitable for Hashable.Make.

Signature

In a module signature, type t [@@deriving hash] will add both hash_fold_t and hash (or hash_<T>) to the signature.

Hashing without a type definition

A folding hash function is accessed/created as [%hash_fold: TYPE]. A direct hash function is accessed/created as [%hash: TYPE].

Special support for record fields

Record fields can be annotated with [@hash.ignore] so that they are not incorporated into the computed hash value. In the case of mutable fields, there must be such an annotation.

    type t = {
      mutable s : string [@hash.ignore];
      x : (int * bool) list;
    }
    [@@deriving hash]

Special support for ppx_compare

The annotation [@compare.ignore] implies [@no_hashing], in order to preserve the invariant that compare x y = 0 implies hash x = hash y.

Adapting code to ppx_hash

So long as all types in support hashing, the following common pattern:

    module T = struct
      type t = <TYPE-EXP> [@@deriving compare, sexp]
      let hash = Hashtbl.hash
    end
    include T
    include Hashable.Make (T)

Can this be written as:

    module T = struct
      type t = <TYPE-EXP> [@@deriving compare, hash, sexp]
    end
    include T
    include Hashable.Make (T)

More information

ppx/ppx_hash/doc/design.notes
ppx/ppx_hash/runtime-lib/make_std.ml

Dependencies (7)

  1. ppxlib >= "0.1.0" & < "0.3.0"
  2. ocaml-migrate-parsetree >= "1.0" & < "2.0.0"
  3. jbuilder >= "1.0+beta18.1"
  4. ppx_sexp_conv >= "v0.11" & < "v0.12"
  5. ppx_compare >= "v0.11" & < "v0.12"
  6. base >= "v0.11" & < "v0.12"
  7. ocaml >= "4.04.1"

Dev Dependencies

None

Used by (9)

  1. boomerang
  2. core_kernel >= "v0.11.0" & < "v0.12.0"
  3. data-encoding >= "0.6"
  4. farith
  5. nsq >= "0.5.0" & < "0.5.2"
  6. opine
  7. ppx_bap < "v0.14.0"
  8. ppx_base = "v0.11.0"
  9. string_dict < "v0.12.0"

Conflicts (1)

  1. jbuilder = "1.0+beta19"