cryptohash 0.1.1 · OCaml Package

type ctx

context type - opaque

type buf =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

buffer type

type t

digest type - opaque

val init : unit -> ctx

Create a new context

val string : string -> t

Return the digest of the given string.

val bytes : Bytes.t -> t

Return the digest of the given byte sequence.

val buffer : buf -> t

Return the digest of the given buffer. All functions with parameters of type buf may release the runtime lock, if the buffer is large enough.

val unsafe_update_substring : ctx -> string -> int -> int -> unit

Sha3_256.unsafe_update_substring ctx s ~pos ~len updates the context with the substring of s starting at character number pos and containing len characters. Unsafe: No range checking!

val unsafe_update_subbytes : ctx -> Bytes.t -> int -> int -> unit

val unsafe_update_subbuffer : ctx -> buf -> int -> int -> unit

val update_substring : ctx -> string -> int -> int -> unit

Sha3_256.update_substring ctx s ofs len updates the context with the substring of s starting at character number ofs and containing len characters. Raise Invalid_argument, if ofs and len do not designate a valid substring of s.

val update_subbytes : ctx -> Bytes.t -> int -> int -> unit

val update_subbuffer : ctx -> buf -> int -> int -> unit

val update_string : ctx -> string -> unit

Sha3_256.update_string ctx s updates the context with s.

val update_bytes : ctx -> Bytes.t -> unit

val update_buffer : ctx -> buf -> unit

val finalize : ctx -> t

Return the final digest and reset the context

val copy : ctx -> ctx

Return a copy of the context

val substring : string -> int -> int -> t

Sha3_256.substring s ofs len returns the digest of the substring of s starting at character number ofs and containing len characters. Raise Invalid_argument, if ofs and len do not designate a valid substring of s.

val subbytes : Bytes.t -> int -> int -> t

val subbuffer : buf -> int -> int -> t

val channel : in_channel -> int -> t

If len is nonnegative, Sha3_256.channel ic len reads len characters from channel ic and returns their digest, or raises End_of_file if end-of-file is reached before len characters are read. If len is negative, Sha3_256.channel ic len reads all characters from ic until end-of-file is reached and return their digest.

val file : string -> t

Return the digest of the file whose name is given.

val file_fast : string -> t

Return the digest of the file whose name is given using fast C function. This function releases the OCaml runtime lock, so other OCaml threads can run in parallel.

val output : out_channel -> t -> unit

Write a digest on the given output channel.

val input : in_channel -> t

Read a digest from the given input channel.

val to_bin : t -> Bytes.t

return a binary representation of the given digest

val to_hex : t -> string

return a printable hexadecimal representation of the given digest

val from_hex : string -> t

reversal of to_hex. Raises Invalid_argument, if the parameter not a valid hexstring

val from_bin : Bytes.t -> t

reversal of to_bin. Raises Invalid_argument, if the parameter not a valid binary. representation

package cryptohash