package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>

Sources

v3.4.0.tar.gz
md5=66b6e0b25769fc2363972c6a6ab6ac33
sha256=584d314cbaa5485e26d08ce87f7d7ff49043d9096101f2641b59def9aa6d7d71

doc/batteries.unthreaded/BatDigest/index.html

Module BatDigest

MD5 message digest.

This module provides functions to compute 128-bit ``digests'' of arbitrary-length strings or files. The digests are of cryptographic quality: it is very hard, given a digest, to forge a string having that digest. The algorithm used is MD5.

  • author Xavier Leroy (Base module)
  • author David Rajchenbach-Teller
type t = string

The type of digests: 16-character strings.

val string : string -> t

Return the digest of the given string.

val bytes : Bytes.t -> t

Return the digest of the given byte sequence.

  • since 2.3.0
val substring : string -> int -> int -> t

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

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

Digest.subbytes s ofs len returns the digest of the subsequence of s starting at index ofs and containing len bytes.

  • since 2.3.0
val file : string -> t

Return the digest of the file whose name is given.

val to_hex : t -> string

Return the printable hexadecimal representation of the given digest.

val from_hex : string -> t

Convert a hexadecimal representation back into the corresponding digest.

  • raises Invalid_argument

    if the argument is not exactly 32 hexadecimal characters.

  • since 4.00.0
val channel : BatIO.input -> int -> Digest.t

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

Note This version of channel is currently very inefficient if len < 0 and requires copying the whole input to a temporary file.

val output : 'a BatIO.output -> t -> unit

Write a digest on the given output.

val print : 'a BatIO.output -> Digest.t -> unit

Write a digest on the given output in hexadecimal.

val input : BatIO.input -> Digest.t

Read a digest from the given input.

val compare : t -> t -> int

The comparison function for 16-character digest, with the same specification as Pervasives.compare and the implementation shared with String.compare. Along with the type t, this function compare allows the module Digest to be passed as argument to the functors Set.Make and Map.Make.

  • since Batteries 2.0
val equal : t -> t -> bool

The equal function for digests.

  • since 2.5.0