package sha

  1. Overview
  2. Docs

Module Sha256Source

SHA256 OCaml binding

Sourcetype ctx

Context type - opaque.

Buffer type.

Sourcetype t

Digest type - opaque.

Sourceval zero : t

The zero digest.

Sourceval init : unit -> ctx

Create a new context.

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

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

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

Sha256.update_substring ctx s ofs len updates the context with the substring of s starting at character number ofs and containing len characters.

Sourceval update_string : ctx -> string -> unit

Sha256.update_string ctx s updates the context with s.

Sourceval update_buffer : ctx -> buf -> unit

Sha256.update_buffer ctx a updates the context with a. Runs parallel to other threads if any exist.

Sourceval finalize : ctx -> t

Finalize the context and return digest.

Sourceval copy : ctx -> ctx

Return a copy of the context.

Sourceval string : string -> t

Return the digest of the given string.

Sourceval substring : string -> int -> int -> t

Sha256.substring s ofs len returns the digest of the substring of s starting at character number ofs and containing len characters.

Sourceval buffer : buf -> t

Return the digest of the given buffer.

Sourceval channel : in_channel -> int -> t

If len is nonnegative, Sha256.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, Sha256.channel ic len reads all characters from ic until end-of-file is reached and return their digest.

Sourceval file : string -> t

Return the digest of the file whose name is given.

Sourceval file_fast : string -> t

Return the digest of the file whose name is given using fast C function.

Sourceval output : out_channel -> t -> unit

Write a digest on the given output channel.

Sourceval input : in_channel -> t

Read a digest from the given input channel.

Sourceval to_bin : t -> string

Return a binary representation of the given digest.

Sourceval to_hex : t -> string

Return a printable hexadecimal representation of the given digest.

Sourceval equal : t -> t -> bool

Returns whether two hashes are equal.

Sourceval of_bin : bytes -> t

Sha256.of_bin digest converts the binary representation of a digest to the internal representation of Sha256.t.

Sourceval of_hex : string -> t

Sha256.of_hex digest converts the hexadecimal representation of a digest to the internal representation of Sha256.t.