summaryrefslogtreecommitdiff
path: root/stdlib/digest.mli
diff options
context:
space:
mode:
authorAlain Frisch <alain@frisch.fr>2012-01-18 08:31:11 +0000
committerAlain Frisch <alain@frisch.fr>2012-01-18 08:31:11 +0000
commitc45bcb892d78f3182acb2805aef7ec6e23cce42a (patch)
treeb92b5d6becb9e67a198bc2e070d748eeef62bc3d /stdlib/digest.mli
parentcdbb84ec682704379bac21a633cbd2b9e93b35a8 (diff)
parent869feeb00704e0640c45ffe6aee6cc13e4077f79 (diff)
downloadocaml-unused_declarations.tar.gz
Synchronize with trunk.unused_declarations
git-svn-id: http://caml.inria.fr/svn/ocaml/branches/unused_declarations@12034 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/digest.mli')
-rw-r--r--stdlib/digest.mli12
1 files changed, 11 insertions, 1 deletions
diff --git a/stdlib/digest.mli b/stdlib/digest.mli
index 14f27e2630..01a5f8ba8a 100644
--- a/stdlib/digest.mli
+++ b/stdlib/digest.mli
@@ -18,12 +18,22 @@
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.
+ that digest. The algorithm used is MD5. This module should not be
+ used for secure and sensitive cryptographic applications. For these
+ kind of applications more recent and stronger cryptographic
+ primitives should be used instead.
*)
type t = string
(** The type of digests: 16-character strings. *)
+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}. *)
+
val string : string -> t
(** Return the digest of the given string. *)