jon.recoil.org

Parameter F.Hash

val description : string @@ portable

Name of the hash-function, e.g., "internalhash", "siphash"

type state

state is the internal hash-state used by the hash function.

val fold_int : Hash.state -> int -> Hash.state @@ portable

fold_<T> state v incorporates a value v of type <T> into the hash-state, returning a modified hash-state. Implementations of the fold_<T> functions may mutate the state argument in place, and return a reference to it. Implementations of the fold_<T> functions should not allocate.

val fold_int64 : Hash.state -> int64 -> Hash.state @@ portable
val fold_float : Hash.state -> float -> Hash.state @@ portable
val fold_string : Hash.state -> string -> Hash.state @@ portable
type seed

seed is the type used to seed the initial hash-state.

val alloc : unit -> Hash.state @@ portable

alloc () returns a fresh uninitialized hash-state. May allocate.

val reset : ?seed:Hash.seed -> Hash.state -> Hash.state @@ portable

reset ?seed state initializes/resets a hash-state with the given seed, or else a default-seed. Argument state may be mutated. Should not allocate.

type hash_value

hash_value The type of hash values, returned by get_hash_value.

val get_hash_value : Hash.state -> Hash.hash_value @@ portable

get_hash_value extracts a hash-value from the hash-state.

module For_tests : sig ... end