package sha

  1. Overview
  2. Docs
package sha
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Sha1

SHA1 OCaml binding

type ctx

context type - opaque

buffer type

type t

digest type - opaque

val zero : t

The zero digest

val init : unit -> ctx

Create a new context

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

Sha1.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!

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

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

val update_string : ctx -> string -> unit

Sha1.update_string ctx s updates the context with s.

val update_buffer : ctx -> buf -> unit

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

val finalize : ctx -> t

Finalize the context and return digest

val copy : ctx -> ctx

Return an copy of the context

val string : string -> t

Return the digest of the given string.

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

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

val channel : in_channel -> int -> t

If len is nonnegative, Sha1.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, Sha1.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

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 -> string

return a binary representation of the given digest

val to_hex : t -> string

return a printable hexadecimal representation of the given digest