package ocaml-base-compiler

  1. Overview
  2. Docs
Official release 5.1.1

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (70)

Authors

  1. Xavier Leroy

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

5.1.1.tar.gz
sha256=57f7b382b3d71198413ede405d95ef3506f1cdc480cda1dca1e26b37cb090e17

doc/stdlib/Stdlib/Digest/index.html

Module Stdlib.DigestSource

MD5 message digest.

This module provides functions to compute 128-bit 'digests' of arbitrary-length strings or files. The algorithm used is MD5.

The MD5 hash function is not cryptographically secure. Hence, this module should not be used for security-sensitive applications. More recent, stronger cryptographic primitives should be used instead.

Sourcetype t = string

The type of digests: 16-character strings.

Sourceval compare : t -> t -> int

The comparison function for 16-character digest, with the same specification as Stdlib.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 4.00
Sourceval equal : t -> t -> bool

The equal function for 16-character digest.

  • since 4.03
Sourceval string : string -> t

Return the digest of the given string.

Sourceval bytes : bytes -> t

Return the digest of the given byte sequence.

  • since 4.02
Sourceval substring : string -> int -> int -> t

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

Sourceval subbytes : bytes -> 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 4.02
Sourceval channel : in_channel -> int -> 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.

Sourceval file : string -> t

Return the digest of the file whose name is given.

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_hex : t -> string

Return the printable hexadecimal representation of the given digest.

Sourceval 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